Logo ROOT   6.21/01
Reference Guide
TCivetweb Class Reference

Definition at line 18 of file TCivetweb.h.

Public Member Functions

 TCivetweb (Bool_t only_secured=kFALSE)
 constructor More...
 
virtual ~TCivetweb ()
 destructor More...
 
virtual Bool_t Create (const char *args)
 Creates embedded civetweb server As main argument, http port should be specified like "8090". More...
 
Int_t GetMaxAge () const
 
const char * GetTopName () const
 
Bool_t IsDebugMode () const
 
Bool_t IsTerminating () 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
THttpServerGetServer () const
 Returns pointer to THttpServer associated with engine. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 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...
 
- 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 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 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 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...
 
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 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
 
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). 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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 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
 
virtual void Terminate ()
 Method called when server want to be terminated. More...
 
- Protected Member Functions inherited from THttpEngine
 THttpEngine (const char *name, const char *title)
 normal constructor More...
 
virtual void Process ()
 Method regularly called in main ROOT context. More...
 
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). More...
 
void MakeZombie ()
 

Protected Attributes

voidfCallbacks {nullptr}
 ! call-back table for civetweb webserver More...
 
voidfCtx {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...
 
- Protected Attributes inherited from THttpEngine
THttpServerfServer
 ! 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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_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...
 

#include </mnt/build/workspace/root-makedoc/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 416 of file TCivetweb.cxx.

◆ ~TCivetweb()

TCivetweb::~TCivetweb ( )
virtual

destructor

Definition at line 425 of file TCivetweb.cxx.

Member Function Documentation

◆ Create()

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

Creates embedded civetweb server 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 Examples: http:8080?websocket_disable http:7546?thrds=30&websocket_timeout=20

Reimplemented from THttpEngine.

Definition at line 466 of file TCivetweb.cxx.

◆ GetMaxAge()

Int_t TCivetweb::GetMaxAge ( ) const
inline

Definition at line 46 of file TCivetweb.h.

◆ GetTopName()

const char* TCivetweb::GetTopName ( ) const
inline

Definition at line 38 of file TCivetweb.h.

◆ IsDebugMode()

Bool_t TCivetweb::IsDebugMode ( ) const
inline

Definition at line 40 of file TCivetweb.h.

◆ IsSecured()

Bool_t TCivetweb::IsSecured ( ) const
inlineprotected

Definition at line 30 of file TCivetweb.h.

◆ IsTerminating()

Bool_t TCivetweb::IsTerminating ( ) const
inline

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

◆ Terminate()

virtual void TCivetweb::Terminate ( void  )
inlineprotectedvirtual

Method called when server want to be terminated.

Reimplemented from THttpEngine.

Definition at line 28 of file TCivetweb.h.

Member Data Documentation

◆ fCallbacks

void* TCivetweb::fCallbacks {nullptr}
protected

! call-back table for civetweb webserver

Definition at line 21 of file TCivetweb.h.

◆ fCtx

void* TCivetweb::fCtx {nullptr}
protected

! civetweb context

Definition at line 20 of file TCivetweb.h.

◆ fDebug

Bool_t TCivetweb::fDebug {kFALSE}
protected

! debug mode

Definition at line 23 of file TCivetweb.h.

◆ fMaxAge

Int_t TCivetweb::fMaxAge {3600}
protected

! max-age parameter

Definition at line 26 of file TCivetweb.h.

◆ fOnlySecured

Bool_t TCivetweb::fOnlySecured {kFALSE}
protected

! if server should run only https protocol

Definition at line 25 of file TCivetweb.h.

◆ fTerminating

Bool_t TCivetweb::fTerminating {kFALSE}
protected

! server doing shutdown and not react on requests

Definition at line 24 of file TCivetweb.h.

◆ fTopName

TString TCivetweb::fTopName
protected

! name of top item

Definition at line 22 of file TCivetweb.h.


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