THttpServer Class Reference

Online http server for arbitrary ROOT application.

Note

This class provides HTTP access to ROOT objects. The user is entirely responsible for the security of the server. It is strongly recommended to use the server only within an isolated network or to enable proper authentication to prevent unauthorized remote access.

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:

1. standard http interface to ROOT application
2. no any temporary ROOT files when access data
3. 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 Types
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
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)) }

Public Member Functions
	THttpServer (const char *engine="http:8080")
	constructor
virtual	~THttpServer ()
	destructor
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
void	AddLocation (const char *prefix, const char *path)
	Add files location, which could be used in the server.
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.
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 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.
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).
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.
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message.
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
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.
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.
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.
const char *	GetItemField (const char *fullname, const char *name)
	Get item field from sniffer.
const char *	GetName () const override
	Returns 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
TRootSniffer *	GetSniffer () const
	returns pointer on objects sniffer
const char *	GetTitle () const override
	Returns title of object.
const char *	GetTopName () const
	returns name of top item in objects hierarchy
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.
ULong_t	Hash () const override
	Return hash value for this object.
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.
Bool_t	Hide (const char *fullname, Bool_t hide=kTRUE)
	Hides folder or element from web gui.
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)
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	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).
Bool_t	IsFileRequested (const char *uri, TString &res) const
	Check if file is requested, thread safe.
virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t	IsOnHeap () const
Bool_t	IsReadOnly () const
	returns read-only mode
Bool_t	IsSortable () const override
Bool_t	IsTerminated () const
	returns kTRUE, if server was terminated
Bool_t	IsWSOnly () const
	returns true if only websockets are handled by the server
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List TNamed name and title.
void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *, size_t)
	Operator delete for sized deallocation.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete (void *ptr, void *vp)
	Only called by placement new when throwing an exception.
void	operator delete[] (void *, size_t)
	Operator delete [] for sized deallocation.
void	operator delete[] (void *ptr)
	Operator delete [].
void	operator delete[] (void *ptr, void *vp)
	Only called by placement new[] when throwing an exception.
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, void *vp)
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.
void	Print (Option_t *option="") const override
	Print TNamed name and title.
Int_t	ProcessRequests ()
	Process submitted requests, must be called from appropriate thread.
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.
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	ResetBit (UInt_t f)
void	Restrict (const char *path, const char *options)
	Restrict access to specified object.
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.
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.
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
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.
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).
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.
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
void	SetTopName (const char *top)
	set name of top item in objects hierarchy
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
void	SetWSOnly (Bool_t on=kTRUE)
	Set websocket-only mode.
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)
Bool_t	SubmitHttp (std::shared_ptr< THttpCallArg > arg, Bool_t can_run_immediately=kFALSE)
	Submit HTTP request.
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
Bool_t	Unregister (TObject *obj)
	Unregister object.
void	UnregisterWS (std::shared_ptr< THttpWSHandler > ws)
	Unregister WS handler.
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 Longptr_t	GetDtorOnly ()
	Return destructor only flag.
static const char *	GetMimeType (const char *path)
	Guess mime type base on file extension.
static Bool_t	GetObjectStat ()
	Get status of object stat flag.
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 void	SetDtorOnly (void *obj)
	Set destructor only flag.
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

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

Protected Member Functions
	THttpServer (const THttpServer &)=delete
std::string	BuildWSEntryPage ()
	Create summary page with active WS handlers.
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()
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	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".
void	StopServerThread ()
	Stop server thread.

Static Protected Member Functions
static void	SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
	Save array in the output stream "out" as vector.
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
TString	fName
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	fTitle
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

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

#include <THttpServer.h>

Inheritance diagram for THttpServer:

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer. This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

EStatusBits

enum TObject::EStatusBits

inherited

Enumerator
kCanDelete	if object in a list can be deleted
kMustCleanup	if object destructor must call RecursiveRemove()
kIsReferenced	if object is referenced by a TRef or TRefArray
kHasUUID	if object has a TUUID (its fUniqueID=UUIDNumber)
kCannotPick	if object in a pad cannot be picked
kNoContextMenu	if object does not want context menu
kInvalidObject	if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

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

~THttpServer()

THttpServer::~THttpServer ( )

virtual

destructor

delete all http engines and sniffer

Definition at line 222 of file THttpServer.cxx.

Member Function Documentation

AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning

This interface is a legacy function that is no longer recommended to be used by new development code.

Note

The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

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

AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

Browse()

void TObject::Browse ( TBrowser * b )

virtualinherited

Browse object. May be overridden for another default action.

Reimplemented in RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TASImage, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TChain, TClass, TCollection, TCollectionPropertyBrowsable, TDatabasePDG, TDirectory, TDirectoryFile, TEfficiency, TF1, TFolder, TGenerator, TGeoManager, TGeometry, TGeoNode, TGeoOverlap, TGeoTrack, TGeoVolume, TGraph2D, TGraph, TH1, THbookBranch, THbookFile, THbookKey, THnBase, THStack, TKey, TKeyMapFile, TLeaf, TMacro, TMapFile, TMultiDimFit, TMultiGraph, TNode, TNtuple, TNtupleD, TPad, TPair, TParticleClassPDG, TPrincipal, TRecorder, TRemoteObject, TROOT, TRootIconList, TSPlot, TStyle, TSystemDirectory, TSystemFile, TTask, TTree, TTreePerfStats, and TVirtualBranchBrowsable.

Definition at line 218 of file TObject.cxx.

BuildWSEntryPage()

std::string THttpServer::BuildWSEntryPage ( )

protected

Create summary page with active WS handlers.

Definition at line 787 of file THttpServer.cxx.

CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

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

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

Class()

TClass * THttpServer::Class ( )

static

Returns

TClass describing this class

Class_Name()

const char * THttpServer::Class_Name ( )

static

Returns

Name of this class

Class_Version()

constexpr Version_t THttpServer::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 198 of file THttpServer.h.

ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

Clear()

void TNamed::Clear ( Option_t * option = "" )

overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

Clone()

TObject * TNamed::Clone ( const char * newname = "" ) const

overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

Compare()

Int_t TNamed::Compare ( const TObject * obj ) const

overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

Copy()

void TNamed::Copy ( TObject & named ) const

overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

CreateEngine()

Bool_t THttpServer::CreateEngine ( const char * engine )

virtual

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

CreateItem()

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

Create item in sniffer.

Definition at line 1434 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 492 of file THttpServer.cxx.

DeclFileName()

const char * THttpServer::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 198 of file THttpServer.h.

Delete()

void TObject::Delete ( Option_t * option = "" )

virtualinherited

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented in RooLinkedList, TAxis, TBtree, TCanvas, TClonesArray, TCollection, TDirectory, TDirectoryFile, TExMap, TFile, TGFrame, TGItemContext, TGTextEdit, THashList, THashTable, TKey, TKeySQL, TKeyXML, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TMVA::Results, TObjArray, TObjectTable, TOrdCollection, TProtoClass, TQCommand, TRefArray, TSystemDirectory, TSystemFile, TThread, TTree, TTreeViewer, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 268 of file TObject.cxx.

DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive ( Int_t px, Int_t py )

virtualinherited

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

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

DoError()

void TObject::DoError ( int level, const char * location, const char * fmt, va_list va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

Draw()

void TObject::Draw ( Option_t * option = "" )

virtualinherited

Default Draw method for all objects.

Reimplemented in RooAbsData, RooPlot, RooStats::HypoTestInverterPlot, RooStats::SamplingDistPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::RGeoPainter, TArrow, TASImage, TBox, TBrowser, TButton, TCanvas, TChain, TClass, TClassTree, TCollection, TColorWheel, TDiamond, TDirectory, TEfficiency, TEllipse, TEveGeoNode, TEveGeoTopNode, TF1, TF2, TF3, TFile, TFITSHDU, TFrame, TGenerator, TGeoBatemanSol, TGeometry, TGeoNode, TGeoOverlap, TGeoPainter, TGeoParallelWorld, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoTrack, TGeoVGShape, TGeoVolume, TGItemContext, TGListTree, TGPicture, TGraph2D, TGraph, TGraphPolar, TGraphPolargram, TGraphStruct, TGraphTime, TH1, THelix, THStack, TLegend, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMultiDimFit, TMultiGraph, TMultiLayerPerceptron, TNode, TNodeDiv, TPad, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TPave, TPaveLabel, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TRatioPlot, TSpider, TSpline, TStructViewer, TStructViewerGUI, TTree, TTreePerfStats, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, and TWbox.

Definition at line 293 of file TObject.cxx.

DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note

For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

Error()

void TObject::Error ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

Execute() [1/2]

void TObject::Execute ( const char * method, const char * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

Execute() [2/2]

void TObject::Execute ( TMethod * method, TObjArray * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

ExecuteEvent()

void TObject::ExecuteEvent ( Int_t event, Int_t px, Int_t py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

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

Fatal()

void TObject::Fatal ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

FillBuffer()

void TNamed::FillBuffer ( char *& buffer )

virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

FindObject() [1/2]

TObject * TObject::FindObject ( const char * name ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.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 1265 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.

GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

GetIconName()

const char * TObject::GetIconName ( ) const

virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

GetItemField()

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

Get item field from sniffer.

Definition at line 1450 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 1458 of file THttpServer.cxx.

GetName()

const char * TNamed::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px, Int_t py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

GetOption()

virtual Option_t * TObject::GetOption ( ) const

inlinevirtualinherited

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

GetSniffer()

TRootSniffer * THttpServer::GetSniffer ( ) const

inline

returns pointer on objects sniffer

Definition at line 89 of file THttpServer.h.

GetTitle()

const char * TNamed::GetTitle ( ) const

inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

GetTopName()

const char * THttpServer::GetTopName ( ) const

inline

returns name of top item in objects hierarchy

Definition at line 130 of file THttpServer.h.

GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

Hash()

ULong_t TNamed::Hash ( ) const

inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

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

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

Hide()

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

Hides folder or element from web gui.

Definition at line 1415 of file THttpServer.cxx.

Info()

void TObject::Info ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

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.

IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note

This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns

true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

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

IsFolder()

Bool_t TObject::IsFolder ( ) const

virtualinherited

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

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TClass, TCollection, TDatabasePDG, TDirectory, TFolder, TGeoManager, TGeometry, TGeoNode, TGeoNodeMatrix, TGeoOverlap, TGeoTrack, TGeoVolume, THbookFile, THbookKey, THnBase, TKey, TMapFile, TMultiDimFit, TNode, TPad, TPair, TParticleClassPDG, TPrincipal, TRemoteObject, TROOT, TRootIconList, TSPlot, TSystemDirectory, TTask, TTree, and TVirtualBranchBrowsable.

Definition at line 579 of file TObject.cxx.

IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

IsReadOnly()

Bool_t THttpServer::IsReadOnly

(

)

const

returns read-only mode

Definition at line 262 of file THttpServer.cxx.

IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

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

IsZombie()

Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

ls()

void TNamed::ls ( Option_t * option = "" ) const

overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

MakeZombie()

void TObject::MakeZombie ( )

inlineprotectedinherited

Definition at line 55 of file TObject.h.

MayNotUse()

void TObject::MayNotUse ( const char * method ) const

inherited

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

Definition at line 1160 of file TObject.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 763 of file THttpServer.cxx.

Notify()

Bool_t TObject::Notify ( )

virtualinherited

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

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

Obsolete()

void TObject::Obsolete ( const char * method, const char * asOfVers, const char * removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

operator delete() [1/3]

void TObject::operator delete ( void * ptr, size_t size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

operator delete() [3/3]

void TObject::operator delete ( void * ptr, void * vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr, size_t size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr, void * vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

operator new() [2/2]

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

inlineinherited

Definition at line 191 of file TObject.h.

operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

operator new[]() [2/2]

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

inlineinherited

Definition at line 192 of file TObject.h.

operator=()

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

protecteddelete

Paint()

void TObject::Paint ( Option_t * option = "" )

virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

Print()

void TNamed::Print ( Option_t * option = "" ) const

overridevirtualinherited

Print TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TParallelCoordRange, TParallelCoordVar, TParticleClassPDG, TParticlePDG, TPrincipal, TScatter2D, TScatter, TSpectrum2, TSpectrum3, TSpectrum, TSQLColumnInfo, TSQLFile, TSQLTableInfo, TText, TTree, TTreeIndex, TXMLFile, and TXTRU.

Definition at line 127 of file TNamed.cxx.

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 774 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 950 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 683 of file THttpServer.cxx.

Read()

Int_t TObject::Read ( const char * name )

virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.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 1536 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 1562 of file THttpServer.cxx.

RecursiveRemove()

void TObject::RecursiveRemove ( TObject * obj )

virtualinherited

Recursively remove this object from a list.

Typically implemented by classes that can contain multiple references to a same object.

Reimplemented in RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::RBrowserDataCleanup, RooWorkspace, TBrowser, TChain, TCling, TCollection, TDialogCanvas, TDirectory, TEfficiency, TFileMerger, TFitEditor, TFolder, TFriendElement, TGedEditor, TGeometry, TGFileBrowser, TGraph2D, TGraph, TH1, TH1Editor, TH2Editor, THashList, THistPainter, THStack, TInspectCanvas, TLegend, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMultiGraph, TNode, TObjArray, TObjectRefSpy, TObjectSpy, TPad, TProcessID, TROOT, TRootBrowser, TRootBrowserHistory, TRootBrowserLite, TRootContextMenu, TTree, TTreePlayer, TViewPubDataMembers, TViewPubFunctions, and TVirtualPad.

Definition at line 684 of file TObject.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 1223 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 1407 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 1243 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 822 of file THttpServer.cxx.

ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

Restrict()

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

Restrict access to specified object.

See TRootSniffer::Restrict() for more details

Definition at line 1365 of file THttpServer.cxx.

SaveAs()

void TObject::SaveAs ( const char * filename = "", Option_t * option = "" ) const

virtualinherited

Save this object in the file specified by filename.

• if "filename" contains ".root" the object is saved in filename as root binary file.
• if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
• if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().

• otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

  The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out, Option_t * option = "" )

virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out, TClass * cl, const char * variable_name, const char * constructor_agrs = "", Bool_t empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out, const char * variable_name, Option_t * option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out, const char * variable_name )

protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out, const char * prefix, Int_t len, Double_t * arr, Int_t flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

SetBit() [2/2]

void TObject::SetBit ( UInt_t f, Bool_t set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.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 345 of file THttpServer.cxx.

SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.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 364 of file THttpServer.cxx.

SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.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 1426 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 1442 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:

• https://root.cern/js/7.11.0/
• https://jsroot.gsi.de/7.11.0/

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

SetName()

void TNamed::SetName ( const char * name )

virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

SetNameTitle()

void TNamed::SetNameTitle ( const char * name, const char * title )

virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.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 273 of file THttpServer.cxx.

SetSniffer()

void THttpServer::SetSniffer

(

TRootSniffer *

sniff

)

Set TRootSniffer to the server.

Server takes ownership over sniffer

Definition at line 244 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 254 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 467 of file THttpServer.cxx.

SetTitle()

void TNamed::SetTitle ( const char * title = "" )

virtualinherited

Set the title of the TNamed.

Reimplemented in Axis2, RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::TSchemaRule::TSources, TASImage, TEfficiency, TF1, TGraph2D, TGraph, TH1, THnBase, TParallelCoordVar, TSystemDirectory, and TSystemFile.

Definition at line 173 of file TNamed.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.

SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

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

Sizeof()

Int_t TNamed::Sizeof ( ) const

virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

StopServerThread()

void THttpServer::StopServerThread ( )

protected

Stop server thread.

Normally called shortly before http server destructor

Definition at line 524 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 656 of file THttpServer.cxx.

SysError()

void TObject::SysError ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

TestBit()

Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

Unregister()

Bool_t THttpServer::Unregister

(

TObject *

obj

)

Unregister object.

Unregister object in folders hierarchy.

See TRootSniffer::UnregisterObject() for more details

Definition at line 1233 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 1252 of file THttpServer.cxx.

UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

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

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.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 539 of file THttpServer.cxx.

Warning()

void TObject::Warning ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

• Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
• The TBuffer object is filled via the class::Streamer function.
• If the file is compressed (default) a second buffer is created to hold the compressed buffer.
• Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
• The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

fArgs

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

protected

! submitted arguments

Definition at line 58 of file THttpServer.h.

fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.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.

fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.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.

fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.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.

fTitle

TString TNamed::fTitle

protectedinherited

Definition at line 33 of file TNamed.h.

fTopName

TString THttpServer::fTopName {"ROOT"}

protected

! name of top folder, default - "ROOT"

Definition at line 45 of file THttpServer.h.

fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.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.

---

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

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