Logo ROOT  
Reference Guide
TWebGuiCallArg Class Reference

Class TWebGuiCallArg Specialized handler of requests in THttpServer with QWebEngine.

Definition at line 76 of file rooturlschemehandler.cpp.

Public Member Functions

 TWebGuiCallArg (QWebEngineUrlRequestJob *req=nullptr)
 
virtual ~TWebGuiCallArg ()
 
const char * GetWSKind () const override
 provide WS kind
More...
 
const char * GetWSPlatform () const override
 provide WS platform, intentionally keep qt5 here while it only used on client side More...
 
void HttpReplied () override
 virtual method to inform object that http request is processed More...
 
void SendFile (const char *fname)
 
- Public Member Functions inherited from THttpCallArg
 THttpCallArg ()
 
virtual ~THttpCallArg ()
 destructor More...
 
void AddHeader (const char *name, const char *value)
 Set name: value pair to reply header. More...
 
void AddNoCacheHeader ()
 Set CacheControl http header to disable browser caching. More...
 
virtual Bool_t CanPostpone () const
 Return true if reply can be postponed by server
More...
 
Bool_t CompressWithGzip ()
 Compress reply data with gzip compression. More...
 
template<class T , typename... Args>
void CreateWSEngine (Args... args)
 
std::string FillHttpHeader (const char *header=nullptr)
 Fills HTTP header, which can be send at the beginning of reply on the http request. More...
 
const void * GetContent () const
 
Long_t GetContentLength () const
 
const char * GetContentType () const
 
const char * GetFileName () const
 returns file name from request URL More...
 
TString GetHeader (const char *name)
 Return specified header. More...
 
TString GetHeaderName (Int_t number) const
 returns field name in header More...
 
const char * GetMethod () const
 returns request method like GET or POST More...
 
const char * GetPathName () const
 returns path name from request URL More...
 
const void * GetPostData () const
 return pointer on posted with request data More...
 
Long_t GetPostDataLength () const
 return length of posted with request data More...
 
const char * GetQuery () const
 returns request query (string after ? in request URL) More...
 
TString GetRequestHeader (const char *name)
 get named field from request header More...
 
TString GetRequestHeaderName (Int_t number) const
 returns field name in request header More...
 
const char * GetTopName () const
 returns engine-specific top-name More...
 
const char * GetUserName () const
 return authenticated user name (0 - when no authentication) More...
 
UInt_t GetWSId () const
 get web-socket id More...
 
virtual const char * GetWSKind () const
 provide WS kind - websocket, longpoll, rawlongpoll More...
 
virtual const char * GetWSPlatform () const
 provide WS platform - http, fastcgi, cef3, qt5 More...
 
Int_t GetZipping () const
 
virtual void HttpReplied ()
 virtual method to inform object that http request is processed More...
 
Bool_t Is404 () const
 
TClassIsA () const override
 
Bool_t IsBinary () const
 
Bool_t IsContentType (const char *typ) const
 
Bool_t IsFile () const
 
Bool_t IsJson () const
 
Bool_t IsMethod (const char *name) const
 returns kTRUE if post method is used More...
 
Bool_t IsPostMethod () const
 returns kTRUE if post method is used More...
 
Bool_t IsPostponed () const
 
Bool_t IsText () const
 
Bool_t IsXml () const
 
void NotifyCondition ()
 Method used to notify condition which waiting when operation will complete. More...
 
Int_t NumHeader () const
 returns number of fields in header More...
 
Int_t NumRequestHeader () const
 returns number of fields in request header More...
 
void ReplaceAllinContent (const std::string &from, const std::string &to, bool once=false)
 Replace all occurrences of string in content. More...
 
void Set404 ()
 mark reply as 404 error - page/request not exists or refused More...
 
void SetBinary ()
 Set content type as "application/x-binary". More...
 
void SetBinaryContent (std::string &&bin)
 Set content type as "application/x-binary" and also assigns content. More...
 
void SetContent (const char *cont)
 Set content as text. More...
 
void SetContent (std::string &&cont)
 Set text or binary content directly After method call argument cont will be in undefined state. More...
 
void SetContentType (const char *typ)
 set content type like "text/xml" or "application/json" More...
 
void SetEncoding (const char *typ)
 Set Content-Encoding header like gzip. More...
 
void SetExtraHeader (const char *name, const char *value)
 add extra http header value to the reply More...
 
void SetFile (const char *filename=nullptr)
 indicate that http request should response with file content More...
 
void SetFileName (const char *f)
 set request file name More...
 
void SetJson ()
 Set content type as "application/json". More...
 
void SetJsonContent (std::string &&json)
 Set content type as "application/json" and also assigns content. More...
 
void SetMethod (const char *method)
 set request method kind like GET or POST More...
 
void SetPathAndFileName (const char *fullpath)
 Set complete path of requested http element. More...
 
void SetPathName (const char *p)
 set request path name More...
 
void SetPostData (std::string &&data)
 Set data, which is posted with the request. More...
 
void SetPostData (void *data, Long_t length, Bool_t make_copy=kFALSE)
 Set data, posted with the request. More...
 
void SetPostponed ()
 mark as postponed - reply will not be send to client immediately More...
 
void SetQuery (const char *q)
 set request query More...
 
void SetRequestHeader (const char *h)
 set full set of request header More...
 
void SetText ()
 Set content type as "text/plain". More...
 
void SetTextContent (std::string &&txt)
 Set content type as "text/plain" and also assigns content. More...
 
void SetTopName (const char *topname)
 set engine-specific top-name More...
 
void SetUserName (const char *n)
 set name of authenticated user More...
 
void SetWSId (UInt_t id)
 set web-socket id More...
 
void SetXml ()
 Set content type as "text/xml". More...
 
void SetXmlContent (std::string &&xml)
 Set content type as "text/xml" and also assigns content. More...
 
void SetZipping (Int_t mode=kZipLarge)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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_tGetOption () 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 TClassIsA () const
 
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)
 
TObjectoperator= (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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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 Attributes

UrlRequestJobHolder fRequest
 
- Protected Attributes inherited from THttpCallArg
std::condition_variable fCond
 ! condition used to wait for processing More...
 
TString fContentType
 ! type of content More...
 
TString fFileName
 ! file name More...
 
TString fHeader
 ! response header like ContentEncoding, Cache-Control and so on More...
 
TString fMethod
 ! request method like GET or POST More...
 
Bool_t fNotifyFlag {kFALSE}
 ! indicate that notification called More...
 
TString fPathName
 ! item path More...
 
TString fQuery
 ! additional arguments More...
 
TString fRequestHeader
 ! complete header, provided with request More...
 
TString fTopName
 ! top item name More...
 
TString fUserName
 ! authenticated user name (if any) More...
 
UInt_t fWSId {0}
 ! websocket identifier, used in web-socket related operations More...
 
Int_t fZipping {kNoZip}
 ! indicate if and when content should be compressed More...
 

Additional Inherited Members

- Public Types inherited from THttpCallArg
enum  { kNoZip = 0 , kZip = 1 , kZipLarge = 2 , kZipAlways = 3 }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Static Public Member Functions inherited from THttpCallArg
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_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 = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from THttpCallArg
TString AccessHeader (TString &buf, const char *name, const char *value=nullptr, Bool_t doing_set=kFALSE)
 method used to get or set http header in the string buffer More...
 
TString CountHeader (const TString &buf, Int_t number=-1111) const
 method used to counter number of headers or returns name of specified header 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 ()
 
Inheritance diagram for TWebGuiCallArg:
[legend]

Constructor & Destructor Documentation

◆ TWebGuiCallArg()

TWebGuiCallArg::TWebGuiCallArg ( QWebEngineUrlRequestJob *  req = nullptr)
inlineexplicit

Definition at line 82 of file rooturlschemehandler.cpp.

◆ ~TWebGuiCallArg()

virtual TWebGuiCallArg::~TWebGuiCallArg ( )
inlinevirtual

Definition at line 84 of file rooturlschemehandler.cpp.

Member Function Documentation

◆ GetWSKind()

const char * TWebGuiCallArg::GetWSKind ( ) const
inlineoverridevirtual

provide WS kind

Reimplemented from THttpCallArg.

Definition at line 87 of file rooturlschemehandler.cpp.

◆ GetWSPlatform()

const char * TWebGuiCallArg::GetWSPlatform ( ) const
inlineoverridevirtual

provide WS platform, intentionally keep qt5 here while it only used on client side

Reimplemented from THttpCallArg.

Definition at line 90 of file rooturlschemehandler.cpp.

◆ HttpReplied()

void TWebGuiCallArg::HttpReplied ( )
inlineoverridevirtual

virtual method to inform object that http request is processed

Normally condition is notified and waiting thread will be awaked One could reimplement this method in sub-class

Reimplemented from THttpCallArg.

Definition at line 125 of file rooturlschemehandler.cpp.

◆ SendFile()

void TWebGuiCallArg::SendFile ( const char *  fname)
inline

Definition at line 92 of file rooturlschemehandler.cpp.

Member Data Documentation

◆ fRequest

UrlRequestJobHolder TWebGuiCallArg::fRequest
protected

Definition at line 79 of file rooturlschemehandler.cpp.


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