THttpEngine implementation, based on civetweb embedded server.

It is default kind of engine, created for THttpServer Currently v1.15 from https://github.com/civetweb/civetweb is used

Additional options can be specified:

top=foldername - name of top folder, seen in the browser
thrds=N        - use N threads to run civetweb server (default 5)
auth_file      - global authentication file
auth_domain    - domain name, used for authentication

Example:

new THttpServer("http:8080?top=MyApp&thrds=3");

For the full list of supported options see TCivetweb::Create() documentation

When auth_file and auth_domain parameters are specified, access to running http server will be possible only after user authentication, using so-call digest method. To generate authentication file, htdigest routine should be used:

[shell] htdigest -c .htdigest domain_name user

When creating server, parameters should be:

auto serv = new THttpServer("http:8080?auth_file=.htdigets&auth_domain=domain_name");

Definition at line 21 of file TCivetweb.h.

Public Member Functions
	TCivetweb (Bool_t only_secured=kFALSE)
	constructor

virtual	~TCivetweb ()
	destructor

Int_t	ChangeNumActiveThrerads (int cnt=0)
	Returns number of actively used threads.

Bool_t	Create (const char *args) override
	Creates embedded civetweb server.

Int_t	GetMaxAge () const

Int_t	GetNumAvailableThreads ()
	Returns number of actively used threads.

Int_t	GetNumThreads () const

const char *	GetTopName () const

Bool_t	IsDebugMode () const

Bool_t	IsTerminating () const

Bool_t	IsWebGui () const

Bool_t	IsWinSymLinks () const

Int_t	ProcessLog (const char *message)
	process civetweb log message, can be used to detect critical errors

Public Member Functions inherited from THttpEngine
THttpServer *	GetServer () const
	Returns pointer to THttpServer associated with engine.

TClass *	IsA () const override

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *, size_t)
	Operator delete for sized deallocation.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *, size_t)
	Operator delete [] for sized deallocation.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
Bool_t	IsSecured () const

void	Terminate () override
	Method called when server want to be terminated.

Protected Member Functions inherited from THttpEngine
	THttpEngine (const char name, const char title)
	constructor

virtual void	Process ()
	Method regularly called in main ROOT context.

void	SetServer (THttpServer *serv)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
struct mg_callbacks	fCallbacks
	! call-back table for civetweb webserver

struct mg_context *	fCtx {nullptr}
	! civetweb context

Bool_t	fDebug {kFALSE}
	! debug mode

Int_t	fMaxAge {3600}
	! max-age parameter

std::mutex	fMutex
	! mutex to read/write fNumActiveThreads

Int_t	fNumActiveThreads {0}
	! number of active threads - used in request and websocket handling

Int_t	fNumThreads {10}
	! number of configured threads

Bool_t	fOnlySecured {kFALSE}
	! if server should run only https protocol

Bool_t	fTerminating {kFALSE}
	! server doing shutdown and not react on requests

TString	fTopName
	! name of top item

Bool_t	fWebGui {kFALSE}
	! if server used for webgui

Bool_t	fWinSymLinks {kTRUE}
	! resolve symbolic links on Windows

Protected Attributes inherited from THttpEngine
THttpServer *	fServer {nullptr}
	! object server

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Static Public Member Functions inherited from THttpEngine
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include </github/home/ROOT-CI/src/net/http/src/TCivetweb.h>

Inheritance diagram for TCivetweb:

[legend]

Constructor & Destructor Documentation

◆ TCivetweb()

TCivetweb::TCivetweb ( Bool_t only_secured = kFALSE )

constructor

Definition at line 518 of file TCivetweb.cxx.

◆ ~TCivetweb()

TCivetweb::~TCivetweb ( )

virtual

destructor

Definition at line 527 of file TCivetweb.cxx.

Member Function Documentation

◆ ChangeNumActiveThrerads()

Int_t TCivetweb::ChangeNumActiveThrerads ( int cnt = 0 )

Returns number of actively used threads.

Definition at line 556 of file TCivetweb.cxx.

◆ Create()

Bool_t TCivetweb::Create ( const char * args )

overridevirtual

Creates embedded civetweb server.

Parameters

args	string with civetweb server configuration

As main argument, http port should be specified like "8090". Or one can provide combination of ipaddress and portnumber like "127.0.0.1:8090" Or one can specify unix socket name like "x/tmp/root.socket" Extra parameters like in URL string could be specified after '?' mark:

thrds=N               - there N is number of threads used by the civetweb (default is 10)
top=name              - configure top name, visible in the web browser
ssl_certificate=filename - SSL certificate, see docs/OpenSSL.md from civetweb
auth_file=filename    - authentication file name, created with htdigets utility
auth_domain=domain    - authentication domain
websocket_timeout=tm  - set web sockets timeout in seconds (default 300)
websocket_disable     - disable web sockets handling (default enabled)
bind                  - ip address to bind server socket
loopback              - bind specified port to loopback 127.0.0.1 address
debug                 - enable debug mode, server always returns html page with request info
log=filename          - configure civetweb log file
max_age=value         - configures "Cache-Control: max_age=value" http header for all file-related requests, default 3600
socket_mode=value     - configures unix socket mode, default is 0700
nocache               - try to fully disable cache control for file requests
winsymlinks=no        - do not resolve symbolic links on file system (Windows only), default true
dirlisting=no         - enable/disable directory listing for browsing filesystem (default no)

Examples of valid args values:

serv->CreateEngine("http:8080?websocket_disable");
serv->CreateEngine("http:7546?thrds=30&websocket_timeout=20");

Reimplemented from THttpEngine.

Definition at line 596 of file TCivetweb.cxx.

◆ GetMaxAge()

Int_t TCivetweb::GetMaxAge ( ) const

inline

Definition at line 64 of file TCivetweb.h.

◆ GetNumAvailableThreads()

Int_t TCivetweb::GetNumAvailableThreads ( )

Returns number of actively used threads.

Definition at line 547 of file TCivetweb.cxx.

◆ GetNumThreads()

Int_t TCivetweb::GetNumThreads ( ) const

inline

Definition at line 46 of file TCivetweb.h.

◆ GetTopName()

const char * TCivetweb::GetTopName ( ) const

inline

Definition at line 52 of file TCivetweb.h.

◆ IsDebugMode()

Bool_t TCivetweb::IsDebugMode ( ) const

inline

Definition at line 56 of file TCivetweb.h.

◆ IsSecured()

Bool_t TCivetweb::IsSecured ( ) const

inlineprotected

Definition at line 38 of file TCivetweb.h.

◆ IsTerminating()

Bool_t TCivetweb::IsTerminating ( ) const

inline

Definition at line 58 of file TCivetweb.h.

◆ IsWebGui()

Bool_t TCivetweb::IsWebGui ( ) const

inline

Definition at line 54 of file TCivetweb.h.

◆ IsWinSymLinks()

Bool_t TCivetweb::IsWinSymLinks ( ) const

inline

Definition at line 60 of file TCivetweb.h.

◆ ProcessLog()

Int_t TCivetweb::ProcessLog ( const char * message )

process civetweb log message, can be used to detect critical errors

Definition at line 536 of file TCivetweb.cxx.

◆ Terminate()

void TCivetweb::Terminate ( )

inlineoverrideprotectedvirtual

Method called when server want to be terminated.

Reimplemented from THttpEngine.

Definition at line 36 of file TCivetweb.h.

Member Data Documentation

◆ fCallbacks

struct mg_callbacks TCivetweb::fCallbacks

protected

! call-back table for civetweb webserver

Definition at line 24 of file TCivetweb.h.

◆ fCtx

struct mg_context* TCivetweb::fCtx {nullptr}

protected

! civetweb context

Definition at line 23 of file TCivetweb.h.

◆ fDebug

Bool_t TCivetweb::fDebug {kFALSE}

protected

! debug mode

Definition at line 30 of file TCivetweb.h.

◆ fMaxAge

Int_t TCivetweb::fMaxAge {3600}

protected

! max-age parameter

Definition at line 33 of file TCivetweb.h.

◆ fMutex

std::mutex TCivetweb::fMutex

protected

! mutex to read/write fNumActiveThreads

Definition at line 27 of file TCivetweb.h.

◆ fNumActiveThreads

Int_t TCivetweb::fNumActiveThreads {0}

protected

! number of active threads - used in request and websocket handling

Definition at line 26 of file TCivetweb.h.

◆ fNumThreads

Int_t TCivetweb::fNumThreads {10}

protected

! number of configured threads

Definition at line 25 of file TCivetweb.h.

◆ fOnlySecured

Bool_t TCivetweb::fOnlySecured {kFALSE}

protected

! if server should run only https protocol

Definition at line 32 of file TCivetweb.h.

◆ fTerminating

Bool_t TCivetweb::fTerminating {kFALSE}

protected

! server doing shutdown and not react on requests

Definition at line 31 of file TCivetweb.h.

◆ fTopName

TString TCivetweb::fTopName

protected

! name of top item

Definition at line 28 of file TCivetweb.h.

◆ fWebGui

Bool_t TCivetweb::fWebGui {kFALSE}

protected

! if server used for webgui

Definition at line 29 of file TCivetweb.h.

◆ fWinSymLinks

Bool_t TCivetweb::fWinSymLinks {kTRUE}

protected

! resolve symbolic links on Windows

Definition at line 34 of file TCivetweb.h.

net/http/src/TCivetweb.h

net/http/src/TCivetweb.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TCivetweb()

◆ ~TCivetweb()

Member Function Documentation

◆ ChangeNumActiveThrerads()

◆ Create()

◆ GetMaxAge()

◆ GetNumAvailableThreads()

◆ GetNumThreads()

◆ GetTopName()

◆ IsDebugMode()

◆ IsSecured()

◆ IsTerminating()

◆ IsWebGui()

◆ IsWinSymLinks()

◆ ProcessLog()

◆ Terminate()

Member Data Documentation

◆ fCallbacks

◆ fCtx

◆ fDebug

◆ fMaxAge

◆ fMutex

◆ fNumActiveThreads

◆ fNumThreads

◆ fOnlySecured

◆ fTerminating

◆ fTopName

◆ fWebGui

◆ fWinSymLinks