Online http server for arbitrary ROOT application.

Idea of THttpServer - provide remote http access to running ROOT application and enable HTML/JavaScript user interface. Any registered object can be requested and displayed in the browser. There are many benefits of such approach:

standard http interface to ROOT application
no any temporary ROOT files when access data
user interface running in all browsers

To start http server simply create instance of the THttpServer class like:

serv = new THttpServer("http:8080");

This will starts civetweb-based http server with http port 8080. Than one should be able to open address "http://localhost:8080" in any modern web browser (Firefox, Chrome, Opera, ...) and browse objects, created in ROOT application. By default, server can access files, canvases and histograms via gROOT pointer. All such objects can be displayed with JSROOT graphics.

At any time one could register other objects with the command:

TGraph* gr = new TGraph(10);
gr->SetName("gr1");
serv->Register("graphs/subfolder", gr);

If objects content is changing in the application, one could enable monitoring flag in the browser - than objects view will be regularly updated.

More information: https://root.cern/root/htmldoc/guides/HttpServer/HttpServer.html

Definition at line 31 of file THttpServer.h.

Public Member Functions
	THttpServer (const char *engine="http:8080")
	constructor

virtual	~THttpServer ()
	destructor

void	AddLocation (const char prefix, const char path)
	Add files location, which could be used in the server.

Bool_t	CreateEngine (const char *engine)
	Factory method to create different http engines.

Bool_t	CreateItem (const char fullname, const char title)
	Create item in sniffer.

void	CreateServerThread ()
	Creates special thread to process all requests, directed to http server.

Bool_t	ExecuteHttp (std::shared_ptr< THttpCallArg > arg)
	Execute HTTP request.

Bool_t	ExecuteWS (std::shared_ptr< THttpCallArg > &arg, Bool_t external_thrd=kFALSE, Bool_t wait_process=kFALSE)
	Execute WS request.

std::shared_ptr< THttpWSHandler >	FindWS (const char *name)
	Find web-socket handler with given name.

const char *	GetCors () const
	Returns specified CORS domain.

const char *	GetCorsCredentials () const
	Returns specified CORS credentials value - if any.

const char *	GetItemField (const char fullname, const char name)
	Get item field from sniffer.

TRootSniffer *	GetSniffer () const
	returns pointer on objects sniffer

const char *	GetTopName () const
	returns name of top item in objects hierarchy

Bool_t	Hide (const char *fullname, Bool_t hide=kTRUE)
	Hides folder or element from web gui.

TClass *	IsA () const override

Bool_t	IsAnyEngine () const

Bool_t	IsCors () const
	Returns kTRUE if CORS was configured.

Bool_t	IsCorsCredentials () const
	Returns kTRUE if Access-Control-Allow-Credentials header should be used.

Bool_t	IsFileRequested (const char *uri, TString &res) const
	Check if file is requested, thread safe.

Bool_t	IsReadOnly () const
	returns read-only mode

Bool_t	IsTerminated () const
	returns kTRUE, if server was terminated

Bool_t	IsWSOnly () const
	returns true if only websockets are handled by the server

Int_t	ProcessRequests ()
	Process submitted requests, must be called from appropriate thread.

Bool_t	Register (const char subfolder, TObject obj)
	Register object in subfolder.

Bool_t	RegisterCommand (const char cmdname, const char method, const char *icon=nullptr)
	Register command which can be executed from web interface.

void	RegisterWS (std::shared_ptr< THttpWSHandler > ws)
	Register WS handler.

void	Restrict (const char path, const char options)
	Restrict access to specified object.

void	SetCors (const std::string &domain="*")
	Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-Control-Allow-Origin" header.

void	SetCorsCredentials (const std::string &value="true")
	Enable/disable usage Access-Control-Allow-Credentials response header.

void	SetDefaultPage (const std::string &filename="")
	Set default HTML page.

void	SetDrawPage (const std::string &filename="")
	Set drawing HTML page.

Bool_t	SetIcon (const char fullname, const char iconname)
	Set name of icon, used in browser together with the item.

Bool_t	SetItemField (const char fullname, const char name, const char *value)
	Set item field in sniffer.

void	SetJSROOT (const char *location)
	Set location of JSROOT to use with the server.

void	SetReadOnly (Bool_t readonly=kTRUE)
	Set read-only mode for the server (default on)

void	SetSniffer (TRootSniffer *sniff)
	Set TRootSniffer to the server.

void	SetTerminate ()
	set termination flag, no any further requests will be processed

void	SetTimer (Long_t milliSec=100, Bool_t mode=kTRUE)
	Create timer which will invoke ProcessRequests() function periodically.

void	SetTopName (const char *top)
	set name of top item in objects hierarchy

void	SetWSOnly (Bool_t on=kTRUE)
	Set websocket-only mode.

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Bool_t	SubmitHttp (std::shared_ptr< THttpCallArg > arg, Bool_t can_run_immediately=kFALSE)
	Submit HTTP request.

Bool_t	Unregister (TObject *obj)
	Unregister object.

void	UnregisterWS (std::shared_ptr< THttpWSHandler > ws)
	Unregister WS handler.

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 *ptr)
	Operator delete.

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

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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static const char *	GetMimeType (const char *path)
	Guess mime type base on file extension.

static char *	ReadFileContent (const char *filename, Int_t &len)
	Reads content of file from the disk.

static std::string	ReadFileContent (const std::string &filename)
	Reads content of file from the disk, use std::string in return value.

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 Member Functions
	THttpServer (const THttpServer &)=delete

std::string	BuildWSEntryPage ()
	Create summary page with active WS handlers.

virtual void	MissedRequest (THttpCallArg *arg)
	Method called when THttpServer cannot process request.

THttpServer &	operator= (const THttpServer &)=delete

virtual void	ProcessBatchHolder (std::shared_ptr< THttpCallArg > &arg)
	Process special http request for root_batch_holder.js script.

virtual void	ProcessRequest (std::shared_ptr< THttpCallArg > arg)
	Process single http request.

void	ReplaceJSROOTLinks (std::shared_ptr< THttpCallArg > &arg, const std::string &version="")
	Replaces all references like "jsrootsys/..." or other pre-configured pathes.

void	StopServerThread ()
	Stop server thread.

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 ()

Static Protected Member Functions
static Bool_t	VerifyFilePath (const char *fname)
	Checked that filename does not contains relative path below current directory.

Protected Attributes
std::queue< std::shared_ptr< THttpCallArg > >	fArgs
	! submitted arguments

std::string	fCors
	! CORS: sets Access-Control-Allow-Origin header for ProcessRequest responses

std::string	fCorsCredentials
	! CORS: add Access-Control-Allow-Credentials: true response header

std::string	fDefaultPage
	! file name for default page name

std::string	fDefaultPageCont
	! content of default html page

std::string	fDrawPage
	! file name for drawing of single element

std::string	fDrawPageCont
	! content of draw html page

TList	fEngines
	! engines which runs http server

TString	fJSROOT
	! location of external JSROOT files

TString	fJSROOTSYS
	! location of local JSROOT files

std::map< std::string, std::string >	fLocations
	! list of local directories, which could be accessed via server

Long_t	fMainThrdId {0}
	! id of the thread for processing requests

std::mutex	fMutex
	! mutex to protect list with arguments

Bool_t	fOwnThread {kFALSE}
	! true when specialized thread allocated for processing requests

Long_t	fProcessingThrdId {0}
	! id of the thread where events are recently processing

std::unique_ptr< TRootSniffer >	fSniffer
	! sniffer provides access to ROOT objects hierarchy

Bool_t	fTerminated {kFALSE}
	! termination flag, disables all requests processing

std::thread	fThrd
	! own thread

std::unique_ptr< THttpTimer >	fTimer
	! timer used to access main thread

TString	fTopName {"ROOT"}
	! name of top folder, default - "ROOT"

std::vector< std::shared_ptr< THttpWSHandler > >	fWSHandlers
	! list of WS handlers

std::mutex	fWSMutex
	! mutex to protect WS handler lists

Bool_t	fWSOnly {kFALSE}
	! when true, handle only websockets / longpoll engine

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 )) }

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

#include <THttpServer.h>

Inheritance diagram for THttpServer:

[legend]

Constructor & Destructor Documentation

◆ THttpServer() [1/2]

THttpServer::THttpServer ( const THttpServer & )

protecteddelete

◆ THttpServer() [2/2]

THttpServer::THttpServer ( const char * engine = "http: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/js directory, but one could set JSROOTSYS shell variable to specify alternative location

Definition at line 160 of file THttpServer.cxx.

◆ ~THttpServer()

THttpServer::~THttpServer ( )

virtual

destructor

delete all http engines and sniffer

Definition at line 245 of file THttpServer.cxx.

Member Function Documentation

◆ AddLocation()

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

serv->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 332 of file THttpServer.cxx.

◆ BuildWSEntryPage()

std::string THttpServer::BuildWSEntryPage ( )

protected

Create summary page with active WS handlers.

Definition at line 812 of file THttpServer.cxx.

◆ Class()

static TClass * THttpServer::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * THttpServer::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t THttpServer::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 198 of file THttpServer.h.

◆ CreateEngine()

Bool_t THttpServer::CreateEngine ( const char * engine )

Factory method to create different http engines.

At the moment two engine kinds are supported:

civetweb or http (default)
fastcgi

Examples:

// creates civetweb web server with http port 8080
serv->CreateEngine("http:8080");
serv->CreateEngine("civetweb:8080");
serv->CreateEngine(":8080");
// creates fastcgi server with port 9000
serv->CreateEngine("fastcgi:9000");

One could apply additional parameters, using URL syntax:

serv->CreateEngine("http:8080?thrds=10");

Definition at line 419 of file THttpServer.cxx.

◆ CreateItem()

Bool_t THttpServer::CreateItem	(	const char *	fullname,
		const char *	title
	)

Create item in sniffer.

Definition at line 1455 of file THttpServer.cxx.

◆ CreateServerThread()

void THttpServer::CreateServerThread ( )

Creates special thread to process all requests, directed to http server.

Should be used with care - only dedicated instance of TRootSniffer is allowed By default THttpServer allows to access global lists pointers gROOT or gFile. To be on the safe side, all kind of such access performed from the main thread. Therefore usage of specialized thread means that no any global pointers will be accessible by THttpServer

Definition at line 515 of file THttpServer.cxx.

◆ DeclFileName()

static const char * THttpServer::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 198 of file THttpServer.h.

◆ ExecuteHttp()

Bool_t THttpServer::ExecuteHttp ( std::shared_ptr< THttpCallArg > arg )

Execute HTTP request.

Executes http request, specified in THttpCallArg structure.

Method can be called from any thread Actual execution will be done in main ROOT thread, where analysis code is running.

Definition at line 642 of file THttpServer.cxx.

◆ ExecuteWS()

Bool_t THttpServer::ExecuteWS	(	std::shared_ptr< THttpCallArg > &	arg,
		Bool_t	external_thrd = `kFALSE`,
		Bool_t	wait_process = `kFALSE`
	)

Execute WS request.

Execute WS related operation.

Definition at line 1299 of file THttpServer.cxx.

◆ FindWS()

std::shared_ptr< THttpWSHandler > THttpServer::FindWS ( const char * name )

Find web-socket handler with given name.

Search WS handler with given name.

Handler must be registered with RegisterWS() method

Definition at line 1285 of file THttpServer.cxx.

◆ GetCors()

const char * THttpServer::GetCors ( ) const

inline

Returns specified CORS domain.

Definition at line 115 of file THttpServer.h.

◆ GetCorsCredentials()

const char * THttpServer::GetCorsCredentials ( ) const

inline

Returns specified CORS credentials value - if any.

Definition at line 124 of file THttpServer.h.

◆ GetItemField()

const char * THttpServer::GetItemField	(	const char *	fullname,
		const char *	name
	)

Get item field from sniffer.

Definition at line 1471 of file THttpServer.cxx.

◆ GetMimeType()

const char * THttpServer::GetMimeType ( const char * path )

static

Guess mime type base on file extension.

Returns MIME type base on file extension.

Definition at line 1479 of file THttpServer.cxx.

◆ GetSniffer()

TRootSniffer * THttpServer::GetSniffer ( ) const

inline

returns pointer on objects sniffer

Definition at line 89 of file THttpServer.h.

◆ GetTopName()

const char * THttpServer::GetTopName ( ) const

inline

returns name of top item in objects hierarchy

Definition at line 130 of file THttpServer.h.

◆ Hide()

Bool_t THttpServer::Hide	(	const char *	fullname,
		Bool_t	hide = `kTRUE`
	)

Hides folder or element from web gui.

Definition at line 1436 of file THttpServer.cxx.

◆ IsA()

TClass * THttpServer::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 198 of file THttpServer.h.

◆ IsAnyEngine()

Bool_t THttpServer::IsAnyEngine ( ) const

inline

Definition at line 86 of file THttpServer.h.

◆ IsCors()

Bool_t THttpServer::IsCors ( ) const

inline

Returns kTRUE if CORS was configured.

Definition at line 112 of file THttpServer.h.

◆ IsCorsCredentials()

Bool_t THttpServer::IsCorsCredentials ( ) const

inline

Returns kTRUE if Access-Control-Allow-Credentials header should be used.

Definition at line 121 of file THttpServer.h.

◆ IsFileRequested()

Bool_t THttpServer::IsFileRequested	(	const char *	uri,
		TString &	res
	)		const

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 612 of file THttpServer.cxx.

◆ IsReadOnly()

Bool_t THttpServer::IsReadOnly ( ) const

returns read-only mode

Definition at line 285 of file THttpServer.cxx.

◆ IsTerminated()

Bool_t THttpServer::IsTerminated ( ) const

inline

returns kTRUE, if server was terminated

Definition at line 105 of file THttpServer.h.

◆ IsWSOnly()

Bool_t THttpServer::IsWSOnly ( ) const

returns true if only websockets are handled by the server

Typically used by WebGui

Definition at line 307 of file THttpServer.cxx.

◆ MissedRequest()

void THttpServer::MissedRequest ( THttpCallArg * arg )

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 788 of file THttpServer.cxx.

◆ operator=()

THttpServer & THttpServer::operator= ( const THttpServer & )

protecteddelete

◆ ProcessBatchHolder()

void THttpServer::ProcessBatchHolder ( std::shared_ptr< THttpCallArg > & arg )

protectedvirtual

Process special http request for root_batch_holder.js script.

This kind of requests used to hold web browser running in headless mode Intentionally requests does not replied immediately

Definition at line 799 of file THttpServer.cxx.

◆ ProcessRequest()

void THttpServer::ProcessRequest ( std::shared_ptr< THttpCallArg > arg )

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 978 of file THttpServer.cxx.

◆ ProcessRequests()

Int_t THttpServer::ProcessRequests ( )

Process submitted requests, must be called from appropriate thread.

Process requests, submitted for execution.

Returns number of processed requests

Normally invoked by THttpTimer, when somewhere in the code gSystem->ProcessEvents() is called. User can call serv->ProcessRequests() directly, but only from main thread. If special server thread is created, called from that thread

Definition at line 708 of file THttpServer.cxx.

◆ ReadFileContent() [1/2]

char * THttpServer::ReadFileContent	(	const char *	filename,
		Int_t &	len
	)

static

Reads content of file from the disk.

Reads file content.

Deprecated:

Definition at line 1557 of file THttpServer.cxx.

◆ ReadFileContent() [2/2]

std::string THttpServer::ReadFileContent ( const std::string & filename )

static

Reads content of file from the disk, use std::string in return value.

Reads file content, using std::string as container.

Definition at line 1583 of file THttpServer.cxx.

◆ Register()

Bool_t THttpServer::Register	(	const char *	subfolder,
		TObject *	obj
	)

Register object in subfolder.

Register object in folders hierarchy.

See TRootSniffer::RegisterObject() for more details

Definition at line 1243 of file THttpServer.cxx.

◆ RegisterCommand()

Bool_t THttpServer::RegisterCommand	(	const char *	cmdname,
		const char *	method,
		const char *	icon = `nullptr`
	)

Register command which can be executed from web interface.

As method one typically specifies string, which is executed with gROOT->ProcessLine() method. For instance:

serv->RegisterCommand("Invoke","InvokeFunction()");

Or one could specify any method of the object which is already registered to the server. For instance:

serv->Register("/", hpx);
serv->RegisterCommand("/ResetHPX", "/hpx/->Reset()");

Here symbols '/->' separates item name from method to be executed

One could specify additional arguments in the command with syntax like arg1%, arg2% and so on. For example:

serv->RegisterCommand("/ResetHPX", "/hpx/->SetTitle(\"%arg1%\")");
serv->RegisterCommand("/RebinHPXPY", "/hpxpy/->Rebin2D(%arg1%,%arg2%)");

Such parameter(s) will be requested when command clicked in the browser.

Once command is registered, one could specify icon which will appear in the browser:

serv->SetIcon("/ResetHPX", "rootsys/icons/ed_execute.png");

One also can set extra property '_fastcmd', that command appear as tool button on the top of the browser tree:

serv->SetItemField("/ResetHPX", "_fastcmd", "true");

Or it is equivalent to specifying extra argument when register command:

serv->RegisterCommand("/ResetHPX", "/hpx/->Reset()", "button;rootsys/icons/ed_delete.png");

Definition at line 1428 of file THttpServer.cxx.

◆ RegisterWS()

void THttpServer::RegisterWS ( std::shared_ptr< THttpWSHandler > ws )

Register WS handler.

Register WS handler to the THttpServer.

Only such handler can be used in multi-threaded processing of websockets

Definition at line 1263 of file THttpServer.cxx.

◆ ReplaceJSROOTLinks()

void THttpServer::ReplaceJSROOTLinks	(	std::shared_ptr< THttpCallArg > &	arg,
		const std::string &	version = `""`
	)

protected

Replaces all references like "jsrootsys/..." or other pre-configured pathes.

Either using pre-configured JSROOT installation from web or redirect to jsrootsys from the main server path to benefit from browser caching Creates appropriate importmap instead of placeholder

Definition at line 847 of file THttpServer.cxx.

◆ Restrict()

void THttpServer::Restrict	(	const char *	path,
		const char *	options
	)

Restrict access to specified object.

See TRootSniffer::Restrict() for more details

Definition at line 1386 of file THttpServer.cxx.

◆ SetCors()

void THttpServer::SetCors ( const std::string & domain = "*" )

inline

Enable CORS header to ProcessRequests() responses Specified location (typically "*") add as "Access-Control-Allow-Origin" header.

Definition at line 109 of file THttpServer.h.

◆ SetCorsCredentials()

void THttpServer::SetCorsCredentials ( const std::string & value = "true" )

inline

Enable/disable usage Access-Control-Allow-Credentials response header.

Definition at line 118 of file THttpServer.h.

◆ SetDefaultPage()

void THttpServer::SetDefaultPage ( const std::string & filename = "" )

Set default HTML page.

Sets file name, delivered by the server when http address is opened in the browser.

By default, $ROOTSYS/js/files/online.htm page is used When empty filename is specified, default page will be used

Definition at line 368 of file THttpServer.cxx.

◆ SetDrawPage()

void THttpServer::SetDrawPage ( const std::string & filename = "" )

Set drawing HTML page.

Set file name of HTML page, delivered by the server when objects drawing page is requested from the browser By default, $ROOTSYS/js/files/draw.htm page is used When empty filename is specified, default page will be used

Definition at line 387 of file THttpServer.cxx.

◆ SetIcon()

Bool_t THttpServer::SetIcon	(	const char *	fullname,
		const char *	iconname
	)

Set name of icon, used in browser together with the item.

One could use images from $ROOTSYS directory like: serv->SetIcon("/ResetHPX","/rootsys/icons/ed_execute.png");

Definition at line 1447 of file THttpServer.cxx.

◆ SetItemField()

Bool_t THttpServer::SetItemField	(	const char *	fullname,
		const char *	name,
		const char *	value
	)

Set item field in sniffer.

Definition at line 1463 of file THttpServer.cxx.

◆ SetJSROOT()

void THttpServer::SetJSROOT ( const char * location )

Set location of JSROOT to use with the server.

One could specify address like:

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 355 of file THttpServer.cxx.

◆ SetReadOnly()

void THttpServer::SetReadOnly ( Bool_t readonly = kTRUE )

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 296 of file THttpServer.cxx.

◆ SetSniffer()

void THttpServer::SetSniffer ( TRootSniffer * sniff )

Set TRootSniffer to the server.

Server takes ownership over sniffer

Definition at line 267 of file THttpServer.cxx.

◆ SetTerminate()

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 277 of file THttpServer.cxx.

◆ SetTimer()

void THttpServer::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

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 (like malloc) and can lead to dead locks, especially in multi-threaded applications.

Definition at line 490 of file THttpServer.cxx.

◆ SetTopName()

void THttpServer::SetTopName ( const char * top )

inline

set name of top item in objects hierarchy

Definition at line 127 of file THttpServer.h.

◆ SetWSOnly()

void THttpServer::SetWSOnly ( Bool_t on = kTRUE )

Set websocket-only mode.

If true, server will only handle websockets connection plus serving file requests to access jsroot/ui5 scripts

Definition at line 318 of file THttpServer.cxx.

◆ StopServerThread()

void THttpServer::StopServerThread ( )

protected

Stop server thread.

Normally called shortly before http server destructor

Definition at line 547 of file THttpServer.cxx.

◆ Streamer()

void THttpServer::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void THttpServer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 198 of file THttpServer.h.

◆ SubmitHttp()

Bool_t THttpServer::SubmitHttp	(	std::shared_ptr< THttpCallArg >	arg,
		Bool_t	can_run_immediately = `kFALSE`
	)

Submit HTTP request.

Submit http request, specified in THttpCallArg structure.

Contrary to ExecuteHttp, it will not block calling thread. User should implement THttpCallArg::HttpReplied() method to react when HTTP request is executed. Method can be called from any thread Actual execution will be done in main ROOT thread, where analysis code is running. When called from main thread and can_run_immediately==kTRUE, will be executed immediately.

Returns kTRUE when was executed.

Definition at line 681 of file THttpServer.cxx.

◆ Unregister()

Bool_t THttpServer::Unregister ( TObject * obj )

Unregister object.

Unregister object in folders hierarchy.

See TRootSniffer::UnregisterObject() for more details

Definition at line 1253 of file THttpServer.cxx.

◆ UnregisterWS()

void THttpServer::UnregisterWS ( std::shared_ptr< THttpWSHandler > ws )

Unregister WS handler.

Unregister WS handler to the THttpServer.

Definition at line 1272 of file THttpServer.cxx.

◆ VerifyFilePath()

Bool_t THttpServer::VerifyFilePath ( const char * fname )

staticprotected

Checked that filename does not contains relative path below current directory.

Used to prevent access to files below current directory

Definition at line 562 of file THttpServer.cxx.

Member Data Documentation

◆ fArgs

std::queue<std::shared_ptr<THttpCallArg> > THttpServer::fArgs

protected

! submitted arguments

Definition at line 58 of file THttpServer.h.

◆ fCors

std::string THttpServer::fCors

protected

! CORS: sets Access-Control-Allow-Origin header for ProcessRequest responses

Definition at line 54 of file THttpServer.h.

◆ fCorsCredentials

std::string THttpServer::fCorsCredentials

protected

! CORS: add Access-Control-Allow-Credentials: true response header

Definition at line 55 of file THttpServer.h.

◆ fDefaultPage

std::string THttpServer::fDefaultPage

protected

! file name for default page name

Definition at line 50 of file THttpServer.h.

◆ fDefaultPageCont

std::string THttpServer::fDefaultPageCont

protected

! content of default html page

Definition at line 51 of file THttpServer.h.

◆ fDrawPage

std::string THttpServer::fDrawPage

protected

! file name for drawing of single element

Definition at line 52 of file THttpServer.h.

◆ fDrawPageCont

std::string THttpServer::fDrawPageCont

protected

! content of draw html page

Definition at line 53 of file THttpServer.h.

◆ fEngines

TList THttpServer::fEngines

protected

! engines which runs http server

Definition at line 34 of file THttpServer.h.

◆ fJSROOT

TString THttpServer::fJSROOT

protected

! location of external JSROOT files

Definition at line 46 of file THttpServer.h.

◆ fJSROOTSYS

TString THttpServer::fJSROOTSYS

protected

! location of local JSROOT files

Definition at line 44 of file THttpServer.h.

◆ fLocations

std::map<std::string, std::string> THttpServer::fLocations

protected

! list of local directories, which could be accessed via server

Definition at line 48 of file THttpServer.h.

◆ fMainThrdId

Long_t THttpServer::fMainThrdId {0}

protected

! id of the thread for processing requests

Definition at line 38 of file THttpServer.h.

◆ fMutex

std::mutex THttpServer::fMutex

protected

! mutex to protect list with arguments

Definition at line 57 of file THttpServer.h.

◆ fOwnThread

Bool_t THttpServer::fOwnThread {kFALSE}

protected

! true when specialized thread allocated for processing requests

Definition at line 40 of file THttpServer.h.

◆ fProcessingThrdId

Long_t THttpServer::fProcessingThrdId {0}

protected

! id of the thread where events are recently processing

Definition at line 39 of file THttpServer.h.

◆ fSniffer

std::unique_ptr<TRootSniffer> THttpServer::fSniffer

protected

! sniffer provides access to ROOT objects hierarchy

Definition at line 36 of file THttpServer.h.

◆ fTerminated

Bool_t THttpServer::fTerminated {kFALSE}

protected

! termination flag, disables all requests processing

Definition at line 37 of file THttpServer.h.

◆ fThrd

std::thread THttpServer::fThrd

protected

! own thread

Definition at line 41 of file THttpServer.h.

◆ fTimer

std::unique_ptr<THttpTimer> THttpServer::fTimer

protected

! timer used to access main thread

Definition at line 35 of file THttpServer.h.

◆ fTopName

TString THttpServer::fTopName {"ROOT"}

protected

! name of top folder, default - "ROOT"

Definition at line 45 of file THttpServer.h.

◆ fWSHandlers

std::vector<std::shared_ptr<THttpWSHandler> > THttpServer::fWSHandlers

protected

! list of WS handlers

Definition at line 61 of file THttpServer.h.

◆ fWSMutex

std::mutex THttpServer::fWSMutex

protected

! mutex to protect WS handler lists

Definition at line 60 of file THttpServer.h.

◆ fWSOnly

Bool_t THttpServer::fWSOnly {kFALSE}

protected

! when true, handle only websockets / longpoll engine

Definition at line 42 of file THttpServer.h.

Libraries for THttpServer:

[legend]

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

net/http/inc/THttpServer.h
net/http/src/THttpServer.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ THttpServer() [1/2]

◆ THttpServer() [2/2]

◆ ~THttpServer()

Member Function Documentation

◆ AddLocation()

◆ BuildWSEntryPage()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CreateEngine()

◆ CreateItem()

◆ CreateServerThread()

◆ DeclFileName()

◆ ExecuteHttp()

◆ ExecuteWS()

◆ FindWS()

◆ GetCors()

◆ GetCorsCredentials()

◆ GetItemField()

◆ GetMimeType()

◆ GetSniffer()

◆ GetTopName()

◆ Hide()

◆ IsA()

◆ IsAnyEngine()

◆ IsCors()

◆ IsCorsCredentials()

◆ IsFileRequested()

◆ IsReadOnly()

◆ IsTerminated()

◆ IsWSOnly()

◆ MissedRequest()

◆ operator=()

◆ ProcessBatchHolder()

◆ ProcessRequest()

◆ ProcessRequests()

◆ ReadFileContent() [1/2]

◆ ReadFileContent() [2/2]

◆ Register()

◆ RegisterCommand()

◆ RegisterWS()

◆ ReplaceJSROOTLinks()

◆ Restrict()

◆ SetCors()

◆ SetCorsCredentials()

◆ SetDefaultPage()

◆ SetDrawPage()

◆ SetIcon()

◆ SetItemField()

◆ SetJSROOT()

◆ SetReadOnly()

◆ SetSniffer()

◆ SetTerminate()

◆ SetTimer()

◆ SetTopName()

◆ SetWSOnly()

◆ StopServerThread()

◆ Streamer()

◆ StreamerNVirtual()

◆ SubmitHttp()

◆ Unregister()

◆ UnregisterWS()

◆ VerifyFilePath()

Member Data Documentation

◆ fArgs

◆ fCors

◆ fCorsCredentials

◆ fDefaultPage

◆ fDefaultPageCont

◆ fDrawPage

◆ fDrawPageCont

◆ fEngines

◆ fJSROOT