Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RWebWindowWSHandler Class Reference

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

Definition at line 31 of file RWebWindowWSHandler.hxx.

Public Member Functions

 RWebWindowWSHandler (RWebWindow &wind, const char *name)
 constructor
 
virtual ~RWebWindowWSHandler ()=default
 
Bool_t AllowMTProcess () const override
 Allow processing of WS actions in arbitrary thread.
 
Bool_t AllowMTSend () const override
 Allows usage of special threads for send operations.
 
Bool_t CanServeFiles () const override
 returns true when window allowed to serve files relative to default page
 
void CompleteWSSend (UInt_t wsid) override
 React on completion of multi-threaded send operation.
 
TString GetDefaultPageContent () override
 returns content of default web-page THttpWSHandler interface
 
Bool_t ProcessWS (THttpCallArg *arg) override
 Process websocket request - called from THttpServer thread THttpWSHandler interface.
 
- Public Member Functions inherited from THttpWSHandler
virtual ~THttpWSHandler ()
 destructor Make sure that all sending threads are stopped correctly
 
void CloseWS (UInt_t wsid)
 Close connection with given websocket id.
 
Int_t GetNumWS ()
 Returns current number of websocket connections.
 
UInt_t GetWS (Int_t num=0)
 Return websocket id with given sequential number Number of websockets returned with GetNumWS() method.
 
Bool_t HasWS (UInt_t wsid)
 Return kTRUE if websocket with given ID exists.
 
Bool_t IsDisabled () const
 Returns true when processing of websockets is disabled, set shortly before handler need to be destroyed.
 
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.
 
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,.
 
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,.
 
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.
 
void SetDisabled ()
 Disable all processing of websockets, normally called shortly before destructor.
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects.
 
virtual void Copy (TObject &named) const
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification.
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static int GetBoolEnv (const std::string &name, int dfl=-1)
 Parse boolean gEnv variable which should be "yes" or "no" Returns 1 for true or 0 for false Returns.
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Public Attributes

RWebWindowfWindow
 ! window reference
 

Protected Member Functions

Bool_t ProcessBatchHolder (std::shared_ptr< THttpCallArg > &arg) override
 Method used to accept or reject root_batch_holder.js request.
 
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.
 
- Protected Member Functions inherited from THttpWSHandler
 THttpWSHandler (const char *name, const char *title, Bool_t syncmode=kTRUE)
 THttpWSHandler.
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

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)
}
 
- 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-v626/rootspi/rdoc/src/v6-26-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 100 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 125 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 128 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 112 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 131 of file RWebWindowWSHandler.hxx.

◆ GetBoolEnv()

int RWebWindowWSHandler::GetBoolEnv ( const std::string &  name,
int  dflt = -1 
)
static

Parse boolean gEnv variable which should be "yes" or "no" Returns 1 for true or 0 for false Returns.

Parameters
dfltif result is not defined

Definition at line 43 of file RWebWindowsManager.cxx.

◆ GetDefaultPageContent()

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

returns content of default web-page THttpWSHandler interface

Reimplemented from THttpWSHandler.

Definition at line 109 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 34 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 116 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 39 of file RWebWindowWSHandler.hxx.

Member Data Documentation

◆ fWindow

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

! window reference

Definition at line 97 of file RWebWindowWSHandler.hxx.

  • gui/webdisplay/src/RWebWindowWSHandler.hxx
  • gui/webdisplay/src/RWebWindowsManager.cxx