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
const char *	GetWSPlatform () const override
	provide WS platform, intentionally keep qt5 here while it only used on client side
void	HttpReplied () override
	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
void	SendFile (const char *fname)
Public Member Functions inherited from THttpCallArg
	THttpCallArg ()
virtual	~THttpCallArg ()
	destructor
void	AddHeader (const char *name, const char *value)
	Set name: value pair to reply header Content-Type field handled separately - one should use SetContentType() method Content-Length field cannot be set at all;.
void	AddNoCacheHeader ()
	Set CacheControl http header to disable browser caching.
virtual Bool_t	CanPostpone () const
	Return true if reply can be postponed by server
Bool_t	CompressWithGzip ()
	compress reply data with gzip compression
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 beggining of reply on the http request.
const void *	GetContent () const
Long_t	GetContentLength () const
const char *	GetContentType () const
const char *	GetFileName () const
	returns file name from request URL
TString	GetHeader (const char *name)
	return specified header
TString	GetHeaderName (Int_t number) const
	returns field name in header
const char *	GetMethod () const
	returns request method like GET or POST
const char *	GetPathName () const
	returns path name from request URL
const void *	GetPostData () const
	return pointer on posted with request data
Long_t	GetPostDataLength () const
	return length of posted with request data
const char *	GetQuery () const
	returns request query (string after ? in request URL)
TString	GetRequestHeader (const char *name)
	get named field from request header
TString	GetRequestHeaderName (Int_t number) const
	returns field name in request header
const char *	GetTopName () const
	returns engine-specific top-name
const char *	GetUserName () const
	return authenticated user name (0 - when no authentication)
UInt_t	GetWSId () const
	get web-socket id
Int_t	GetZipping () const
Bool_t	Is404 () const
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
Bool_t	IsPostMethod () const
	returns kTRUE if post method is used
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 Condition notified only if not-postponed state is set
Int_t	NumHeader () const
	returns number of fields in header
Int_t	NumRequestHeader () const
	returns number of fields in request header
void	ReplaceAllinContent (const std::string &from, const std::string &to, bool once=false)
	Replace all occurrences of.
void	Set404 ()
	mark reply as 404 error - page/request not exists or refused
void	SetBinary ()
	Set content type as "application/x-binary".
void	SetBinaryContent (std::string &&bin)
	Set content type as "application/x-binary" and also assigns content After method call argument.
void	SetContent (const char *cont)
	Set content as text.
void	SetContent (std::string &&cont)
	Set text or binary content directly After method call argument cont will be in undefined state.
void	SetContentType (const char *typ)
	set content type like "text/xml" or "application/json"
void	SetEncoding (const char *typ)
	Set Content-Encoding header like gzip.
void	SetExtraHeader (const char *name, const char *value)
	add extra http header value to the reply
void	SetFile (const char *filename=nullptr)
	indicate that http request should response with file content
void	SetFileName (const char *f)
	set request file name
void	SetJson ()
	Set content type as "application/json".
void	SetJsonContent (std::string &&json)
	Set content type as "application/json" and also assigns content After method call argument.
void	SetMethod (const char *method)
	set request method kind like GET or POST
void	SetPathAndFileName (const char *fullpath)
	set complete path of requested http element For instance, it could be "/folder/subfolder/get.bin" Here "/folder/subfolder/" is element path and "get.bin" requested file.
void	SetPathName (const char *p)
	set request path name
void	SetPostData (std::string &&data)
	set data, which is posted with the request Although std::string is used, not only text data can be assigned - std::string can contain any sequence of symbols
void	SetPostData (void *data, Long_t length, Bool_t make_copy=kFALSE)
void	SetPostponed ()
	mark as postponed - reply will not be send to client immediately
void	SetQuery (const char *q)
	set request query
void	SetRequestHeader (const char *h)
	set full set of request header
void	SetText ()
	Set content type as "text/plain".
void	SetTextContent (std::string &&txt)
	Set content type as "text/plain" and also assigns content After method call argument.
void	SetTopName (const char *topname)
	set engine-specific top-name
void	SetUserName (const char *n)
	set name of authenticated user
void	SetWSId (UInt_t id)
	set web-socket id
void	SetXml ()
	Set content type as "text/xml".
void	SetXmlContent (std::string &&xml)
	Set content type as "text/xml" and also assigns content After method call argument.
void	SetZipping (Int_t mode=kZipLarge)
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	Clear (Option_t *="")
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.
virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.
virtual void	Copy (TObject &object) const
	Copy this to obj.
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 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 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.
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.
virtual const char *	GetName () const
	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
virtual const char *	GetTitle () const
	Returns title of object.
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.
virtual ULong_t	Hash () const
	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.
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
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.
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 [].
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.
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 void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.
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.

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

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 = 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 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.
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(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 Header has following format: field1 : value1\r\n field2 : value2\r\n Such format corresponds to header format in HTTP requests
TString	CountHeader (const TString &buf, Int_t number=-1111) const
	method used to counter number of headers or returns name of specified header
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 ()

Inheritance diagram for TWebGuiCallArg:

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.