just wrapper to deliver websockets call-backs to the RWebWindow class

Definition at line 33 of file RWebWindowWSHandler.hxx.

Public Member Functions
	RWebWindowWSHandler (RWebWindow &wind, const char *name)
	constructor More...

virtual	~RWebWindowWSHandler ()=default

Bool_t	AllowMTProcess () const override
	Allow processing of WS actions in arbitrary thread. More...

Bool_t	AllowMTSend () const override
	Allows usage of special threads for send operations. More...

Bool_t	CanServeFiles () const override
	returns true when window allowed to serve files relative to default page More...

void	CompleteWSSend (UInt_t wsid) override
	React on completion of multi-threaded send operation. More...

TString	GetDefaultPageContent () override
	returns content of default web-page THttpWSHandler interface More...

Bool_t	ProcessWS (THttpCallArg *arg) override
	Process websocket request - called from THttpServer thread THttpWSHandler interface. More...

Public Member Functions inherited from THttpWSHandler
virtual	~THttpWSHandler ()
	destructor Make sure that all sending threads are stopped correctly More...

virtual Bool_t	AllowMTProcess () const
	Allow processing of WS requests in arbitrary thread. More...

virtual Bool_t	AllowMTSend () const
	Allow send operations in separate threads (when supported by websocket engine) More...

virtual Bool_t	CanServeFiles () const
	If returns kTRUE, allows to serve files from subdirectories where page content is situated. More...

void	CloseWS (UInt_t wsid)
	Close connection with given websocket id. More...

virtual TString	GetDefaultPageContent ()
	Provides content of default web page for registered web-socket handler Can be content of HTML page or file name, where content should be taken For instance, file:/home/user/test.htm or file:$jsrootsys/files/canvas.htm If not specified, default index.htm page will be shown Used by the webcanvas. More...

Int_t	GetNumWS ()
	Returns current number of websocket connections. More...

UInt_t	GetWS (Int_t num=0)
	Return websocket id with given sequential number Number of websockets returned with GetNumWS() method. More...

Bool_t	HasWS (UInt_t wsid)
	Return kTRUE if websocket with given ID exists. More...

Bool_t	IsDisabled () const
	Returns true when processing of websockets is disabled, set shortly before handler need to be destroyed. More...

Bool_t	IsSyncMode () const
	Returns processing mode of WS handler If sync mode is TRUE (default), all event processing and data sending performed in main thread All send functions are blocking and must be performed from main thread If sync mode is false, WS handler can be used from different threads and starts its own sending threads. More...

virtual Bool_t	ProcessWS (THttpCallArg *arg)=0

Int_t	SendCharStarWS (UInt_t wsid, const char *str)
	Send string via given websocket id Returns -1 - in case of error, 0 - when operation was executed immediately, 1 - when send operation will be performed in different thread,. More...

Int_t	SendHeaderWS (UInt_t wsid, const char hdr, const void buf, int len)
	Send binary data with text header via given websocket id Returns -1 - in case of error, 0 - when operation was executed immediately, 1 - when send operation will be performed in different thread,. More...

Int_t	SendWS (UInt_t wsid, const void *buf, int len)
	Send binary data via given websocket id Returns -1 - in case of error 0 - when operation was executed immediately 1 - when send operation will be performed in different thread. More...

void	SetDisabled ()
	Disable all processing of websockets, normally called shortly before destructor. More...

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor. More...

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor. More...

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

virtual void	Copy (TObject &named) const
	Copy this to obj. More...

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...

virtual void	SetName (const char *name)
	Set the name of the TNamed. More...

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

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

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method. More...

virtual void	Copy (TObject &object) const
	Copy this to obj. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

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

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Public Attributes
RWebWindow &	fWindow
	! window reference More...

Protected Member Functions
Bool_t	ProcessBatchHolder (std::shared_ptr< THttpCallArg > &arg) override
	Method used to accept or reject root_batch_holder.js request. More...

void	VerifyDefaultPageContent (std::shared_ptr< THttpCallArg > &arg) override
	Method called when default page content is prepared for use By default no-cache header is provided. More...

Protected Member Functions inherited from THttpWSHandler
	THttpWSHandler (const char name, const char title, Bool_t syncmode=kTRUE)
	THttpWSHandler. More...

virtual void	CompleteWSSend (UInt_t)
	Method called when multi-threaded send operation is completed. More...

virtual Bool_t	ProcessBatchHolder (std::shared_ptr< THttpCallArg > &)
	Method used to accept or reject root_batch_holder.js request. More...

virtual void	VerifyDefaultPageContent (std::shared_ptr< THttpCallArg > &arg)
	Method called when default page content is prepared for use By default no-cache header is provided. More...

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include </home/sftnight/build/workspace/root-makedoc-v622/rootspi/rdoc/src/v6-22-00-patches/gui/webdisplay/src/RWebWindowWSHandler.hxx>

Inheritance diagram for ROOT::Experimental::RWebWindowWSHandler:

[legend]

Constructor & Destructor Documentation

◆ RWebWindowWSHandler()

ROOT::Experimental::RWebWindowWSHandler::RWebWindowWSHandler	(	RWebWindow &	wind,
		const char *	name
	)

inline

constructor

Definition at line 78 of file RWebWindowWSHandler.hxx.

◆ ~RWebWindowWSHandler()

virtual ROOT::Experimental::RWebWindowWSHandler::~RWebWindowWSHandler ( )

virtualdefault

Member Function Documentation

◆ AllowMTProcess()

Bool_t ROOT::Experimental::RWebWindowWSHandler::AllowMTProcess ( ) const

inlineoverridevirtual

Allow processing of WS actions in arbitrary thread.

Reimplemented from THttpWSHandler.

Definition at line 97 of file RWebWindowWSHandler.hxx.

◆ AllowMTSend()

Bool_t ROOT::Experimental::RWebWindowWSHandler::AllowMTSend ( ) const

inlineoverridevirtual

Allows usage of special threads for send operations.

Reimplemented from THttpWSHandler.

Definition at line 100 of file RWebWindowWSHandler.hxx.

◆ CanServeFiles()

Bool_t ROOT::Experimental::RWebWindowWSHandler::CanServeFiles ( ) const

inlineoverridevirtual

returns true when window allowed to serve files relative to default page

Reimplemented from THttpWSHandler.

Definition at line 90 of file RWebWindowWSHandler.hxx.

◆ CompleteWSSend()

void ROOT::Experimental::RWebWindowWSHandler::CompleteWSSend ( UInt_t wsid )

inlineoverridevirtual

React on completion of multi-threaded send operation.

Reimplemented from THttpWSHandler.

Definition at line 103 of file RWebWindowWSHandler.hxx.

◆ GetDefaultPageContent()

TString ROOT::Experimental::RWebWindowWSHandler::GetDefaultPageContent ( )

inlineoverridevirtual

returns content of default web-page THttpWSHandler interface

Reimplemented from THttpWSHandler.

Definition at line 87 of file RWebWindowWSHandler.hxx.

◆ ProcessBatchHolder()

Bool_t ROOT::Experimental::RWebWindowWSHandler::ProcessBatchHolder ( std::shared_ptr< THttpCallArg > & )

inlineoverrideprotectedvirtual

Method used to accept or reject root_batch_holder.js request.

Reimplemented from THttpWSHandler.

Definition at line 36 of file RWebWindowWSHandler.hxx.

◆ ProcessWS()

Bool_t ROOT::Experimental::RWebWindowWSHandler::ProcessWS ( THttpCallArg * arg )

inlineoverridevirtual

Process websocket request - called from THttpServer thread THttpWSHandler interface.

Implements THttpWSHandler.

Definition at line 94 of file RWebWindowWSHandler.hxx.

◆ VerifyDefaultPageContent()

void ROOT::Experimental::RWebWindowWSHandler::VerifyDefaultPageContent ( std::shared_ptr< THttpCallArg > & arg )

inlineoverrideprotectedvirtual

Method called when default page content is prepared for use By default no-cache header is provided.

Reimplemented from THttpWSHandler.

Definition at line 41 of file RWebWindowWSHandler.hxx.

Member Data Documentation

◆ fWindow

RWebWindow& ROOT::Experimental::RWebWindowWSHandler::fWindow

! window reference

Definition at line 75 of file RWebWindowWSHandler.hxx.

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

gui/webdisplay/src/RWebWindowWSHandler.hxx

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ RWebWindowWSHandler()

◆ ~RWebWindowWSHandler()

Member Function Documentation

◆ AllowMTProcess()

◆ AllowMTSend()

◆ CanServeFiles()

◆ CompleteWSSend()

◆ GetDefaultPageContent()

◆ ProcessBatchHolder()

◆ ProcessWS()

◆ VerifyDefaultPageContent()

Member Data Documentation

◆ fWindow