ROOT 6.14/05 Reference Guide |
Definition at line 33 of file THttpServer.h.
Public Member Functions | |
THttpServer (const char *engine="civetweb:8080") | |
constructor More... | |
virtual | ~THttpServer () |
destructor delete all http engines and sniffer More... | |
void | AddLocation (const char *prefix, const char *path) |
add files location, which could be used in the server one could map some system folder to the server like AddLocation("mydir/","/home/user/specials"); Than files from this directory could be addressed via server like http://localhost:8080/mydir/myfile.root More... | |
Bool_t | CreateEngine (const char *engine) |
factory method to create different http engines At the moment two engine kinds are supported: civetweb (default) and fastcgi Examples: "http:8080" or "civetweb:8080" or ":8080" - creates civetweb web server with http port 8080 "fastcgi:9000" - creates fastcgi server with port 9000 One could apply additional parameters, using URL syntax: "http:8080?thrds=10" More... | |
const char * | GetCors () const |
Returns specified CORS domain. More... | |
TRootSniffer * | GetSniffer () const |
returns pointer on objects sniffer More... | |
const char * | GetTopName () const |
returns name of top item in objects hierarchy More... | |
Bool_t | IsAnyEngine () const |
Bool_t | IsCors () const |
Returns kTRUE if CORS was configured. More... | |
Bool_t | IsFileRequested (const char *uri, TString &res) const |
Check if file is requested, thread safe. More... | |
Bool_t | IsReadOnly () const |
returns read-only mode More... | |
Bool_t | IsTerminated () const |
returns kTRUE, if server was terminated More... | |
void | SetCors (const std::string &domain="*") |
Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-Control-Allow-Origin" header. More... | |
void | SetDefaultPage (const std::string &filename="") |
Set file name of HTML page, delivered by the server when http address is opened in the browser. More... | |
void | SetDrawPage (const std::string &filename="") |
Set file name of HTML page, delivered by the server when objects drawing page is requested from the browser By default, $ROOTSYS/etc/http/files/draw.htm page is used When empty filename is specified, default page will be used. More... | |
void | SetJSROOT (const char *location) |
Set location of JSROOT to use with the server One could specify address like: https://root.cern.ch/js/3.3/ http://web-docs.gsi.de/~linev/js/3.3/ This allows to get new JSROOT features with old server, reduce load on THttpServer instance, also startup time can be improved When empty string specified (default), local copy of JSROOT is used (distributed with ROOT) More... | |
void | SetReadOnly (Bool_t readonly) |
Set read-only mode for the server (default on) In read-only server is not allowed to change any ROOT object, registered to the server Server also cannot execute objects method via exe.json request. More... | |
void | SetSniffer (TRootSniffer *sniff) |
Set TRootSniffer to the server Server takes ownership over sniffer. More... | |
void | SetTerminate () |
set termination flag, no any further requests will be processed More... | |
void | SetTimer (Long_t milliSec=100, Bool_t mode=kTRUE) |
create timer which will invoke ProcessRequests() function periodically Timer is required to perform all actions in main ROOT thread Method arguments are the same as for TTimer constructor By default, sync timer with 100 ms period is created More... | |
void | SetTopName (const char *top) |
set name of top item in objects hierarchy 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 TObject * | Clone (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... | |
TNamed & | operator= (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 () |
Checked and record whether for 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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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... | |
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. 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 | |
virtual void | MissedRequest (THttpCallArg *arg) |
Method called when THttpServer cannot process request By default such requests replied with 404 code One could overwrite with method in derived class to process all kinds of such non-standard requests. More... | |
virtual void | ProcessRequest (std::shared_ptr< THttpCallArg > arg) |
Process single http request Depending from requested path and filename different actions will be performed. More... | |
virtual void | ProcessRequest (THttpCallArg *arg) |
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 () |
Static Protected Member Functions | |
static Bool_t | VerifyFilePath (const char *fname) |
Checked that filename does not contains relative path below current directory Used to prevent access to files below current directory. More... | |
Protected Attributes | |
std::queue< std::shared_ptr< THttpCallArg > > | fArgs |
! submitted arguments More... | |
TList | fCallArgs |
! submitted arguments More... | |
std::string | fCors |
! CORS: sets Access-Control-Allow-Origin header for ProcessRequest responses More... | |
std::string | fDefaultPage |
! file name for default page name More... | |
std::string | fDefaultPageCont |
! content of default html page More... | |
std::string | fDrawPage |
! file name for drawing of single element More... | |
std::string | fDrawPageCont |
! content of draw html page More... | |
TList | fEngines |
! engines which runs http server More... | |
TString | fJSROOT |
! location of external JSROOT files More... | |
TString | fJSROOTSYS |
! location of local JSROOT files More... | |
std::map< std::string, std::string > | fLocations |
! list of local directories, which could be accessed via server More... | |
Long_t | fMainThrdId {0} |
! id of the main ROOT process More... | |
std::mutex | fMutex |
! mutex to protect list with arguments More... | |
TRootSniffer * | fSniffer {nullptr} |
! sniffer provides access to ROOT objects hierarchy More... | |
Bool_t | fTerminated {kFALSE} |
! termination flag, disables all requests processing More... | |
THttpTimer * | fTimer {nullptr} |
! timer used to access main thread More... | |
TString | fTopName {"ROOT"} |
! name of top folder, default - "ROOT" 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 <THttpServer.h>
THttpServer::THttpServer | ( | const char * | engine = "civetweb:8080" | ) |
constructor
As argument, one specifies engine kind which should be created like "http:8080". One could specify several engines at once, separating them with semicolon (";"). Following engines are supported:
http - TCivetweb, civetweb-based implementation of http protocol fastcgi - TFastCgi, special protocol for communicating with web servers
For each created engine one should provide socket port number like "http:8080" or "fastcgi:9000". Additional engine-specific options can be supplied with URL syntax like "http:8080?thrds=10". Full list of supported options should be checked in engines docu.
One also can configure following options, separated by semicolon:
readonly, ro - set read-only mode (default) readwrite, rw - allows methods execution of registered objects global - scans global ROOT lists for existing objects (default) noglobal - disable scan of global lists cors - enable CORS header with origin="*" cors=domain - enable CORS header with origin="domain" basic_sniffer - use basic sniffer without support of hist, gpad, graph classes
For example, create http server, which allows cors headers and disable scan of global lists, one should provide "http:8080;cors;noglobal" as parameter
THttpServer uses JavaScript ROOT (https://root.cern/js) to implement web clients UI. Normally JSROOT sources are used from $ROOTSYS/etc/http directory, but one could set JSROOTSYS shell variable to specify alternative location
Definition at line 138 of file THttpServer.cxx.
|
virtual |
destructor delete all http engines and sniffer
Definition at line 205 of file THttpServer.cxx.
void THttpServer::AddLocation | ( | const char * | prefix, |
const char * | path | ||
) |
add files location, which could be used in the server one could map some system folder to the server like AddLocation("mydir/","/home/user/specials"); Than files from this directory could be addressed via server like http://localhost:8080/mydir/myfile.root
Definition at line 283 of file THttpServer.cxx.
Bool_t THttpServer::CreateEngine | ( | const char * | engine | ) |
factory method to create different http engines At the moment two engine kinds are supported: civetweb (default) and fastcgi Examples: "http:8080" or "civetweb:8080" or ":8080" - creates civetweb web server with http port 8080 "fastcgi:9000" - creates fastcgi server with port 9000 One could apply additional parameters, using URL syntax: "http:8080?thrds=10"
Definition at line 352 of file THttpServer.cxx.
|
inline |
Returns specified CORS domain.
Definition at line 97 of file THttpServer.h.
|
inline |
returns pointer on objects sniffer
Definition at line 75 of file THttpServer.h.
|
inline |
returns name of top item in objects hierarchy
Definition at line 103 of file THttpServer.h.
|
inline |
Definition at line 72 of file THttpServer.h.
|
inline |
Returns kTRUE if CORS was configured.
Definition at line 94 of file THttpServer.h.
Check if file is requested, thread safe.
Verifies that request is just file name File names typically contains prefix like "jsrootsys/" If true, method returns real name of the file, which should be delivered to the client Method is thread safe and can be called from any thread.
Definition at line 480 of file THttpServer.cxx.
Bool_t THttpServer::IsReadOnly | ( | ) | const |
returns read-only mode
Definition at line 261 of file THttpServer.cxx.
|
inline |
returns kTRUE, if server was terminated
Definition at line 87 of file THttpServer.h.
|
protectedvirtual |
Method called when THttpServer cannot process request By default such requests replied with 404 code One could overwrite with method in derived class to process all kinds of such non-standard requests.
Definition at line 710 of file THttpServer.cxx.
|
protectedvirtual |
Process single http request Depending from requested path and filename different actions will be performed.
In most cases information is provided by TRootSniffer class
Definition at line 720 of file THttpServer.cxx.
|
protectedvirtual |
In most cases information is provided by TRootSniffer class
Definition at line 788 of file THttpServer.cxx.
|
inline |
Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-Control-Allow-Origin" header.
Definition at line 91 of file THttpServer.h.
void THttpServer::SetDefaultPage | ( | const std::string & | filename = "" | ) |
Set file name of HTML page, delivered by the server when http address is opened in the browser.
By default, $ROOTSYS/etc/http/files/online.htm page is used When empty filename is specified, default page will be used
Definition at line 314 of file THttpServer.cxx.
void THttpServer::SetDrawPage | ( | const std::string & | filename = "" | ) |
Set file name of HTML page, delivered by the server when objects drawing page is requested from the browser By default, $ROOTSYS/etc/http/files/draw.htm page is used When empty filename is specified, default page will be used.
Definition at line 331 of file THttpServer.cxx.
void THttpServer::SetJSROOT | ( | const char * | location | ) |
Set location of JSROOT to use with the server One could specify address like: https://root.cern.ch/js/3.3/ http://web-docs.gsi.de/~linev/js/3.3/ This allows to get new JSROOT features with old server, reduce load on THttpServer instance, also startup time can be improved When empty string specified (default), local copy of JSROOT is used (distributed with ROOT)
Definition at line 303 of file THttpServer.cxx.
Set read-only mode for the server (default on) In read-only server is not allowed to change any ROOT object, registered to the server Server also cannot execute objects method via exe.json request.
Definition at line 271 of file THttpServer.cxx.
void THttpServer::SetSniffer | ( | TRootSniffer * | sniff | ) |
Set TRootSniffer to the server Server takes ownership over sniffer.
Definition at line 242 of file THttpServer.cxx.
void THttpServer::SetTerminate | ( | ) |
set termination flag, no any further requests will be processed
Set termination flag, No any further requests will be processed, server only can be destroyed afterwards.
Definition at line 253 of file THttpServer.cxx.
create timer which will invoke ProcessRequests() function periodically Timer is required to perform all actions in main ROOT thread Method arguments are the same as for TTimer constructor By default, sync timer with 100 ms period is created
It is recommended to always use sync timer mode and only change period to adjust server reaction time. Use of async timer requires, that application regularly calls gSystem->ProcessEvents(). It happens automatically in ROOT interactive shell. If milliSec == 0, no timer will be created. In this case application should regularly call ProcessRequests() method.
Async timer allows to use THttpServer in applications, which does not have explicit gSystem->ProcessEvents() calls. But be aware, that such timer can interrupt any system call (lise malloc) and can lead to dead locks, especially in multi-threaded applications.
Definition at line 414 of file THttpServer.cxx.
|
inline |
set name of top item in objects hierarchy
Definition at line 100 of file THttpServer.h.
|
staticprotected |
Checked that filename does not contains relative path below current directory Used to prevent access to files below current directory.
Definition at line 431 of file THttpServer.cxx.
|
protected |
! submitted arguments
Definition at line 56 of file THttpServer.h.
|
protected |
! submitted arguments
Definition at line 55 of file THttpServer.h.
|
protected |
! CORS: sets Access-Control-Allow-Origin header for ProcessRequest responses
Definition at line 52 of file THttpServer.h.
|
protected |
! file name for default page name
Definition at line 48 of file THttpServer.h.
|
protected |
! content of default html page
Definition at line 49 of file THttpServer.h.
|
protected |
! file name for drawing of single element
Definition at line 50 of file THttpServer.h.
|
protected |
! content of draw html page
Definition at line 51 of file THttpServer.h.
|
protected |
! engines which runs http server
Definition at line 36 of file THttpServer.h.
|
protected |
! location of external JSROOT files
Definition at line 44 of file THttpServer.h.
|
protected |
! location of local JSROOT files
Definition at line 42 of file THttpServer.h.
|
protected |
! list of local directories, which could be accessed via server
Definition at line 46 of file THttpServer.h.
|
protected |
! id of the main ROOT process
Definition at line 40 of file THttpServer.h.
|
protected |
! mutex to protect list with arguments
Definition at line 54 of file THttpServer.h.
|
protected |
! sniffer provides access to ROOT objects hierarchy
Definition at line 38 of file THttpServer.h.
! termination flag, disables all requests processing
Definition at line 39 of file THttpServer.h.
|
protected |
! timer used to access main thread
Definition at line 37 of file THttpServer.h.
|
protected |
! name of top folder, default - "ROOT"
Definition at line 43 of file THttpServer.h.