Logo ROOT  
Reference Guide
TCivetweb Class Reference

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 19 of file TCivetweb.h.

Public Member Functions

 TCivetweb (Bool_t only_secured=kFALSE)
 constructor More...
 
virtual ~TCivetweb ()
 destructor More...
 
Bool_t Create (const char *args) override
 Creates embedded civetweb server. More...
 
Int_t GetMaxAge () const
 
const char * GetTopName () const
 
Bool_t IsDebugMode () const
 
Bool_t IsTerminating () const
 
Bool_t IsWinSymLinks () const
 
Int_t ProcessLog (const char *message)
 process civetweb log message, can be used to detect critical errors More...
 
- Public Member Functions inherited from THttpEngine
virtual Bool_t Create (const char *)
 Method to create all components of engine. More...
 
THttpServerGetServer () const
 Returns pointer to THttpServer associated with engine. More...
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
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. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
void Clear (Option_t *option="") override
 Set name and title to empty strings (""). More...
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility. More...
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects. More...
 
void Copy (TObject &named) const override
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
const char * GetName () const override
 Returns name of object. More...
 
const char * GetTitle () const override
 Returns title of object. More...
 
ULong_t Hash () const override
 Return hash value for this object. More...
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
void Print (Option_t *option="") const override
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual TClassIsA () const
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Member Functions

Bool_t IsSecured () const
 
void Terminate () override
 Method called when server want to be terminated. More...
 
- Protected Member Functions inherited from THttpEngine
 THttpEngine (const char *name, const char *title)
 constructor More...
 
virtual void Process ()
 Method regularly called in main ROOT context. More...
 
void SetServer (THttpServer *serv)
 
virtual void Terminate ()
 Method called when server want to be terminated. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

struct mg_callbacks fCallbacks
 ! call-back table for civetweb webserver More...
 
struct mg_contextfCtx {nullptr}
 ! civetweb context More...
 
Bool_t fDebug {kFALSE}
 ! debug mode More...
 
Int_t fMaxAge {3600}
 ! max-age parameter More...
 
Bool_t fOnlySecured {kFALSE}
 ! if server should run only https protocol More...
 
Bool_t fTerminating {kFALSE}
 ! server doing shutdown and not react on requests More...
 
TString fTopName
 ! name of top item More...
 
Bool_t fWinSymLinks {kTRUE}
 ! resolve symbolic links on Windows More...
 
- Protected Attributes inherited from THttpEngine
THttpServerfServer {nullptr}
 ! object server More...
 
- 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 TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include </home/sftnight/build/workspace/root-makedoc-master/rootspi/rdoc/src/master/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 451 of file TCivetweb.cxx.

◆ ~TCivetweb()

TCivetweb::~TCivetweb ( )
virtual

destructor

Definition at line 460 of file TCivetweb.cxx.

Member Function Documentation

◆ Create()

Bool_t TCivetweb::Create ( const char *  args)
overridevirtual

Creates embedded civetweb server.

Parameters
argsstring 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 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
  • 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 507 of file TCivetweb.cxx.

◆ GetMaxAge()

Int_t TCivetweb::GetMaxAge ( ) const
inline

Definition at line 50 of file TCivetweb.h.

◆ GetTopName()

const char * TCivetweb::GetTopName ( ) const
inline

Definition at line 40 of file TCivetweb.h.

◆ IsDebugMode()

Bool_t TCivetweb::IsDebugMode ( ) const
inline

Definition at line 42 of file TCivetweb.h.

◆ IsSecured()

Bool_t TCivetweb::IsSecured ( ) const
inlineprotected

Definition at line 32 of file TCivetweb.h.

◆ IsTerminating()

Bool_t TCivetweb::IsTerminating ( ) const
inline

Definition at line 44 of file TCivetweb.h.

◆ IsWinSymLinks()

Bool_t TCivetweb::IsWinSymLinks ( ) const
inline

Definition at line 46 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 469 of file TCivetweb.cxx.

◆ Terminate()

void TCivetweb::Terminate ( )
inlineoverrideprotectedvirtual

Method called when server want to be terminated.

Reimplemented from THttpEngine.

Definition at line 30 of file TCivetweb.h.

Member Data Documentation

◆ fCallbacks

struct mg_callbacks TCivetweb::fCallbacks
protected

! call-back table for civetweb webserver

Definition at line 22 of file TCivetweb.h.

◆ fCtx

struct mg_context* TCivetweb::fCtx {nullptr}
protected

! civetweb context

Definition at line 21 of file TCivetweb.h.

◆ fDebug

Bool_t TCivetweb::fDebug {kFALSE}
protected

! debug mode

Definition at line 24 of file TCivetweb.h.

◆ fMaxAge

Int_t TCivetweb::fMaxAge {3600}
protected

! max-age parameter

Definition at line 27 of file TCivetweb.h.

◆ fOnlySecured

Bool_t TCivetweb::fOnlySecured {kFALSE}
protected

! if server should run only https protocol

Definition at line 26 of file TCivetweb.h.

◆ fTerminating

Bool_t TCivetweb::fTerminating {kFALSE}
protected

! server doing shutdown and not react on requests

Definition at line 25 of file TCivetweb.h.

◆ fTopName

TString TCivetweb::fTopName
protected

! name of top item

Definition at line 23 of file TCivetweb.h.

◆ fWinSymLinks

Bool_t TCivetweb::fWinSymLinks {kTRUE}
protected

! resolve symbolic links on Windows

Definition at line 28 of file TCivetweb.h.


The documentation for this class was generated from the following files: