Definition at line 24 of file THttpWSHandler.h.

Public Member Functions
virtual	~THttpWSHandler ()
	destructor Delete all websockets handles 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 () const
	Returns current number of websocket connections. More...

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

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

virtual Bool_t	ProcessWS (THttpCallArg *arg)=0

void	SendCharStarWS (UInt_t wsid, const char *str)
	Send string via given websocket id. More...

void	SendHeaderWS (UInt_t wsid, const char hdr, const void buf, int len)
	Send binary data with binary data via given websocket id. More...

void	SendWS (UInt_t wsid, const void *buf, int len)
	Send binary data via given websocket id. More...

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

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

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

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

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

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

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

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

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

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

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

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

virtual Bool_t	IsSortable () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

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

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

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

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

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

void	InvertBit (UInt_t f)

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

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

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

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

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

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

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

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

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

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

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

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

void	ResetBit (UInt_t f)

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

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

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

void	SetBit (UInt_t f)

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

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

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

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

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

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

Protected Member Functions
	THttpWSHandler (const char name, const char title)
	THttpWSHandler. 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 ()

Private Member Functions
THttpWSEngine *	FindEngine (UInt_t id) const
	Find websocket connection handle with given id. More...

Bool_t	HandleWS (std::shared_ptr< THttpCallArg > &arg)
	Process request to websocket Different kind of requests coded into THttpCallArg::Method "WS_CONNECT" - connection request "WS_READY" - connection ready "WS_CLOSE" - connection closed All other are normal data, which are delivered to users. More...

void	RemoveEngine (THttpWSEngine *engine)
	Remove and destroy WS connection. More...

Private Attributes
std::vector< std::shared_ptr< THttpWSEngine > >	fEngines
	! list of active WS engines (connections) More...

Friends
class	THttpServer

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 Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <THttpWSHandler.h>

Inheritance diagram for THttpWSHandler:

[legend]

Constructor & Destructor Documentation

◆ THttpWSHandler()

THttpWSHandler::THttpWSHandler	(	const char *	name,
		const char *	title
	)

protected

THttpWSHandler.

Class for user-side handling of websocket with THttpServer

Create derived from THttpWSHandler class and implement ProcessWS() method, where all web sockets request handled.

Register instance of derived class to running THttpServer

TUserWSHandler *handler = new TUserWSHandler("name1","title");
THttpServer *server = new THttpServer("http:8090");
server->Register("/subfolder", handler)

Now server can accept web socket connection from outside. For instance, from JavaScirpt one can connect to it with code:
```
var ws = new WebSocket("ws://hostname:8090/subfolder/name1/root.websocket")
```
In the ProcessWS(THttpCallArg *arg) method following code should be implemented:

if (arg->IsMethod("WS_CONNECT")) { return true; // to accept incoming request }

if (arg->IsMethod("WS_READY")) { fWSId = arg->GetWSId(); // fWSId should be member of the user class return true; // connection established }

if (arg->IsMethod("WS_CLOSE")) { fWSId = 0; return true; // confirm close of socket }

if (arg->IsMethod("WS_DATA")) { // received data stored as POST data std::string str((const char *)arg->GetPostData(), arg->GetPostDataLength()); std::cout << "got string " << str << std::endl; // immediately send data back using websocket id SendCharStarWS(fWSId, "our reply"); return true; }normal constructor

Definition at line 67 of file THttpWSHandler.cxx.

◆ ~THttpWSHandler()

THttpWSHandler::~THttpWSHandler ( )

virtual

destructor Delete all websockets handles

Definition at line 75 of file THttpWSHandler.cxx.

Member Function Documentation

◆ CloseWS()

void THttpWSHandler::CloseWS ( UInt_t wsid )

Close connection with given websocket id.

Definition at line 177 of file THttpWSHandler.cxx.

◆ FindEngine()

THttpWSEngine * THttpWSHandler::FindEngine ( UInt_t id ) const

private

Find websocket connection handle with given id.

Definition at line 92 of file THttpWSHandler.cxx.

◆ GetDefaultPageContent()

virtual TString THttpWSHandler::GetDefaultPageContent ( )

inlinevirtual

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.

Definition at line 50 of file THttpWSHandler.h.

◆ GetNumWS()

Int_t THttpWSHandler::GetNumWS ( ) const

inline

Returns current number of websocket connections.

Definition at line 56 of file THttpWSHandler.h.

◆ GetWS()

UInt_t THttpWSHandler::GetWS ( Int_t num = 0 ) const

Return websocket id with given sequential number Number of websockets return with GetNumWS() method.

Definition at line 83 of file THttpWSHandler.cxx.

◆ HandleWS()

Bool_t THttpWSHandler::HandleWS ( std::shared_ptr< THttpCallArg > & arg )

private

Process request to websocket Different kind of requests coded into THttpCallArg::Method "WS_CONNECT" - connection request "WS_READY" - connection ready "WS_CLOSE" - connection closed All other are normal data, which are delivered to users.

Definition at line 121 of file THttpWSHandler.cxx.

◆ HasWS()

Bool_t THttpWSHandler::HasWS ( UInt_t wsid ) const

inline

Return kTRUE if websocket with given ID exists.

Definition at line 53 of file THttpWSHandler.h.

◆ ProcessWS()

virtual Bool_t THttpWSHandler::ProcessWS ( THttpCallArg * arg )

pure virtual

◆ RemoveEngine()

void THttpWSHandler::RemoveEngine ( THttpWSEngine * engine )

private

Remove and destroy WS connection.

Definition at line 104 of file THttpWSHandler.cxx.

◆ SendCharStarWS()

void THttpWSHandler::SendCharStarWS	(	UInt_t	wsid,
		const char *	str
	)

Send string via given websocket id.

Definition at line 210 of file THttpWSHandler.cxx.

◆ SendHeaderWS()

void THttpWSHandler::SendHeaderWS	(	UInt_t	wsid,
		const char *	hdr,
		const void *	buf,
		int	len
	)

Send binary data with binary data via given websocket id.

Definition at line 199 of file THttpWSHandler.cxx.

◆ SendWS()

void THttpWSHandler::SendWS	(	UInt_t	wsid,
		const void *	buf,
		int	len
	)

Send binary data via given websocket id.

Definition at line 188 of file THttpWSHandler.cxx.

Friends And Related Function Documentation

◆ THttpServer

friend class THttpServer

friend

Definition at line 26 of file THttpWSHandler.h.

Member Data Documentation

◆ fEngines

std::vector<std::shared_ptr<THttpWSEngine> > THttpWSHandler::fEngines

private

! list of active WS engines (connections)

Definition at line 30 of file THttpWSHandler.h.

Libraries for THttpWSHandler:

[legend]

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ THttpWSHandler()

◆ ~THttpWSHandler()

Member Function Documentation

◆ CloseWS()

◆ FindEngine()

◆ GetDefaultPageContent()

◆ GetNumWS()

◆ GetWS()

◆ HandleWS()

◆ HasWS()

◆ ProcessWS()

◆ RemoveEngine()

◆ SendCharStarWS()

◆ SendHeaderWS()

◆ SendWS()

Friends And Related Function Documentation

◆ THttpServer

Member Data Documentation

◆ fEngines