Logo ROOT  
Reference Guide
THttpCallArg Class Reference

Definition at line 27 of file THttpCallArg.h.

Public Types

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)
}
 

Public Member Functions

 THttpCallArg ()
 
virtual ~THttpCallArg ()
 destructor More...
 
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;. More...
 
void AddNoCacheHeader ()
 Set CacheControl http header to disable browser caching. 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 beggining of reply on the http request. More...
 
const voidGetContent () 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 voidGetPostData () 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...
 
Int_t GetZipping () const
 
virtual void HttpReplied ()
 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 More...
 
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 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 Condition notified only if not-postponed state is set 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. 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 After method call argument. 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 After method call argument. 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 For instance, it could be "/folder/subfolder/get.bin" Here "/folder/subfolder/" is element path and "get.bin" requested file. More...
 
void SetPathName (const char *p)
 set request path name More...
 
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 More...
 
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 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 After method call argument. 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 After method call argument. More...
 
void SetZipping (Int_t mode=kZipLarge)
 
- 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 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...
 
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. 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...
 

Protected Member Functions

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 More...
 
virtual void CheckWSPageContent (THttpWSHandler *)
 Method used to modify content of web page used by web socket handler. 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 ()
 

Protected Attributes

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...
 

Private Member Functions

void AssignWSId ()
 Assign websocket identifier from the engine. More...
 
std::shared_ptr< THttpWSEngineTakeWSEngine ()
 takeout websocket handle with HTTP call can be done only once More...
 

Private Attributes

std::string fContent
 ! content - text or binary More...
 
std::string fPostData
 ! data received with post request - text - or binary More...
 
std::shared_ptr< THttpWSEnginefWSEngine
 ! web-socket engine, which supplied to run created web socket More...
 

Friends

class THttpServer
 
class THttpWSEngine
 
class THttpWSHandler
 

Additional Inherited Members

- 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...
 

#include <THttpCallArg.h>

Inheritance diagram for THttpCallArg:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kNoZip 
kZip 
kZipLarge 
kZipAlways 

Definition at line 34 of file THttpCallArg.h.

Constructor & Destructor Documentation

◆ THttpCallArg()

THttpCallArg::THttpCallArg ( )
inlineexplicit

Definition at line 77 of file THttpCallArg.h.

◆ ~THttpCallArg()

THttpCallArg::~THttpCallArg ( )
virtual

destructor

Definition at line 32 of file THttpCallArg.cxx.

Member Function Documentation

◆ AccessHeader()

TString THttpCallArg::AccessHeader ( TString buf,
const char *  name,
const char *  value = nullptr,
Bool_t  doing_set = kFALSE 
)
protected

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

Definition at line 43 of file THttpCallArg.cxx.

◆ AddHeader()

void THttpCallArg::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;.

Definition at line 318 of file THttpCallArg.cxx.

◆ AddNoCacheHeader()

void THttpCallArg::AddNoCacheHeader ( )

Set CacheControl http header to disable browser caching.

Definition at line 332 of file THttpCallArg.cxx.

◆ AssignWSId()

void THttpCallArg::AssignWSId ( )
private

Assign websocket identifier from the engine.

Definition at line 240 of file THttpCallArg.cxx.

◆ CheckWSPageContent()

virtual void THttpCallArg::CheckWSPageContent ( THttpWSHandler )
inlineprotectedvirtual

Method used to modify content of web page used by web socket handler.

Definition at line 65 of file THttpCallArg.h.

◆ CompressWithGzip()

Bool_t THttpCallArg::CompressWithGzip ( )

compress reply data with gzip compression

Definition at line 363 of file THttpCallArg.cxx.

◆ CountHeader()

TString THttpCallArg::CountHeader ( const TString buf,
Int_t  number = -1111 
) const
protected

method used to counter number of headers or returns name of specified header

Definition at line 91 of file THttpCallArg.cxx.

◆ CreateWSEngine()

template<class T , typename... Args>
void THttpCallArg::CreateWSEngine ( Args...  args)
inline

Definition at line 235 of file THttpCallArg.h.

◆ FillHttpHeader()

std::string THttpCallArg::FillHttpHeader ( const char *  name = nullptr)

Fills HTTP header, which can be send at the beggining of reply on the http request.

Parameters
nameis HTTP protocol name (default "HTTP/1.1")

Definition at line 341 of file THttpCallArg.cxx.

◆ GetContent()

const void* THttpCallArg::GetContent ( ) const
inline

Definition at line 228 of file THttpCallArg.h.

◆ GetContentLength()

Long_t THttpCallArg::GetContentLength ( ) const
inline

Definition at line 227 of file THttpCallArg.h.

◆ GetContentType()

const char* THttpCallArg::GetContentType ( ) const
inline

Definition at line 217 of file THttpCallArg.h.

◆ GetFileName()

const char* THttpCallArg::GetFileName ( ) const
inline

returns file name from request URL

Definition at line 146 of file THttpCallArg.h.

◆ GetHeader()

TString THttpCallArg::GetHeader ( const char *  name)

return specified header

Definition at line 300 of file THttpCallArg.cxx.

◆ GetHeaderName()

TString THttpCallArg::GetHeaderName ( Int_t  number) const
inline

returns field name in header

Definition at line 193 of file THttpCallArg.h.

◆ GetMethod()

const char* THttpCallArg::GetMethod ( ) const
inline

returns request method like GET or POST

Definition at line 128 of file THttpCallArg.h.

◆ GetPathName()

const char* THttpCallArg::GetPathName ( ) const
inline

returns path name from request URL

Definition at line 143 of file THttpCallArg.h.

◆ GetPostData()

const void* THttpCallArg::GetPostData ( ) const
inline

return pointer on posted with request data

Definition at line 137 of file THttpCallArg.h.

◆ GetPostDataLength()

Long_t THttpCallArg::GetPostDataLength ( ) const
inline

return length of posted with request data

Definition at line 140 of file THttpCallArg.h.

◆ GetQuery()

const char* THttpCallArg::GetQuery ( ) const
inline

returns request query (string after ? in request URL)

Definition at line 152 of file THttpCallArg.h.

◆ GetRequestHeader()

TString THttpCallArg::GetRequestHeader ( const char *  name)
inline

get named field from request header

Definition at line 122 of file THttpCallArg.h.

◆ GetRequestHeaderName()

TString THttpCallArg::GetRequestHeaderName ( Int_t  number) const
inline

returns field name in request header

Definition at line 119 of file THttpCallArg.h.

◆ GetTopName()

const char* THttpCallArg::GetTopName ( ) const
inline

returns engine-specific top-name

Definition at line 125 of file THttpCallArg.h.

◆ GetUserName()

const char* THttpCallArg::GetUserName ( ) const
inline

return authenticated user name (0 - when no authentication)

Definition at line 149 of file THttpCallArg.h.

◆ GetWSId()

UInt_t THttpCallArg::GetWSId ( ) const
inline

get web-socket id

Definition at line 110 of file THttpCallArg.h.

◆ GetZipping()

Int_t THttpCallArg::GetZipping ( ) const
inline

Definition at line 207 of file THttpCallArg.h.

◆ HttpReplied()

void THttpCallArg::HttpReplied ( )
virtual

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

Definition at line 442 of file THttpCallArg.cxx.

◆ Is404()

Bool_t THttpCallArg::Is404 ( ) const
inline

Definition at line 219 of file THttpCallArg.h.

◆ IsBinary()

Bool_t THttpCallArg::IsBinary ( ) const
inline

Definition at line 225 of file THttpCallArg.h.

◆ IsContentType()

Bool_t THttpCallArg::IsContentType ( const char *  typ) const
inline

Definition at line 216 of file THttpCallArg.h.

◆ IsFile()

Bool_t THttpCallArg::IsFile ( ) const
inline

Definition at line 220 of file THttpCallArg.h.

◆ IsJson()

Bool_t THttpCallArg::IsJson ( ) const
inline

Definition at line 224 of file THttpCallArg.h.

◆ IsMethod()

Bool_t THttpCallArg::IsMethod ( const char *  name) const
inline

returns kTRUE if post method is used

Definition at line 131 of file THttpCallArg.h.

◆ IsPostMethod()

Bool_t THttpCallArg::IsPostMethod ( ) const
inline

returns kTRUE if post method is used

Definition at line 134 of file THttpCallArg.h.

◆ IsPostponed()

Bool_t THttpCallArg::IsPostponed ( ) const
inline

Definition at line 221 of file THttpCallArg.h.

◆ IsText()

Bool_t THttpCallArg::IsText ( ) const
inline

Definition at line 222 of file THttpCallArg.h.

◆ IsXml()

Bool_t THttpCallArg::IsXml ( ) const
inline

Definition at line 223 of file THttpCallArg.h.

◆ NotifyCondition()

void THttpCallArg::NotifyCondition ( )

method used to notify condition which waiting when operation will complete Condition notified only if not-postponed state is set

Definition at line 429 of file THttpCallArg.cxx.

◆ NumHeader()

Int_t THttpCallArg::NumHeader ( ) const
inline

returns number of fields in header

Definition at line 190 of file THttpCallArg.h.

◆ NumRequestHeader()

Int_t THttpCallArg::NumRequestHeader ( ) const
inline

returns number of fields in request header

Definition at line 116 of file THttpCallArg.h.

◆ ReplaceAllinContent()

void THttpCallArg::ReplaceAllinContent ( const std::string &  from,
const std::string &  to,
bool  once = false 
)

Replace all occurrences of.

Parameters
fromby
toin content Used only internally

Definition at line 260 of file THttpCallArg.cxx.

◆ Set404()

void THttpCallArg::Set404 ( )
inline

mark reply as 404 error - page/request not exists or refused

Definition at line 160 of file THttpCallArg.h.

◆ SetBinary()

void THttpCallArg::SetBinary ( )

Set content type as "application/x-binary".

Definition at line 197 of file THttpCallArg.cxx.

◆ SetBinaryContent()

void THttpCallArg::SetBinaryContent ( std::string &&  bin)

Set content type as "application/x-binary" and also assigns content After method call argument.

Parameters
binwill be in undefined state

Definition at line 206 of file THttpCallArg.cxx.

◆ SetContent() [1/2]

void THttpCallArg::SetContent ( const char *  cont)

Set content as text.

Content will be copied by THttpCallArg

Definition at line 123 of file THttpCallArg.cxx.

◆ SetContent() [2/2]

void THttpCallArg::SetContent ( std::string &&  cont)

Set text or binary content directly After method call argument cont will be in undefined state.

Definition at line 135 of file THttpCallArg.cxx.

◆ SetContentType()

void THttpCallArg::SetContentType ( const char *  typ)
inline

set content type like "text/xml" or "application/json"

Definition at line 157 of file THttpCallArg.h.

◆ SetEncoding()

void THttpCallArg::SetEncoding ( const char *  typ)
inline

Set Content-Encoding header like gzip.

Definition at line 198 of file THttpCallArg.h.

◆ SetExtraHeader()

void THttpCallArg::SetExtraHeader ( const char *  name,
const char *  value 
)
inline

add extra http header value to the reply

Definition at line 210 of file THttpCallArg.h.

◆ SetFile()

void THttpCallArg::SetFile ( const char *  filename = nullptr)
inline

indicate that http request should response with file content

Definition at line 166 of file THttpCallArg.h.

◆ SetFileName()

void THttpCallArg::SetFileName ( const char *  f)
inline

set request file name

Definition at line 94 of file THttpCallArg.h.

◆ SetJson()

void THttpCallArg::SetJson ( )

Set content type as "application/json".

Definition at line 179 of file THttpCallArg.cxx.

◆ SetJsonContent()

void THttpCallArg::SetJsonContent ( std::string &&  json)

Set content type as "application/json" and also assigns content After method call argument.

Parameters
jsonwill be in undefined state

Definition at line 188 of file THttpCallArg.cxx.

◆ SetMethod()

void THttpCallArg::SetMethod ( const char *  method)
inline

set request method kind like GET or POST

Definition at line 83 of file THttpCallArg.h.

◆ SetPathAndFileName()

void THttpCallArg::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.

One could set path and file name separately

Definition at line 276 of file THttpCallArg.cxx.

◆ SetPathName()

void THttpCallArg::SetPathName ( const char *  p)
inline

set request path name

Definition at line 91 of file THttpCallArg.h.

◆ SetPostData() [1/2]

void THttpCallArg::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

Definition at line 232 of file THttpCallArg.cxx.

◆ SetPostData() [2/2]

void THttpCallArg::SetPostData ( void data,
Long_t  length,
Bool_t  make_copy = kFALSE 
)
Deprecated:
Use signature with std::string Set data, posted with the request If make_copy==kFALSE, data will be released with free(data) call

Definition at line 217 of file THttpCallArg.cxx.

◆ SetPostponed()

void THttpCallArg::SetPostponed ( )
inline

mark as postponed - reply will not be send to client immediately

Definition at line 163 of file THttpCallArg.h.

◆ SetQuery()

void THttpCallArg::SetQuery ( const char *  q)
inline

set request query

Definition at line 100 of file THttpCallArg.h.

◆ SetRequestHeader()

void THttpCallArg::SetRequestHeader ( const char *  h)
inline

set full set of request header

Definition at line 113 of file THttpCallArg.h.

◆ SetText()

void THttpCallArg::SetText ( )

Set content type as "text/plain".

Definition at line 143 of file THttpCallArg.cxx.

◆ SetTextContent()

void THttpCallArg::SetTextContent ( std::string &&  txt)

Set content type as "text/plain" and also assigns content After method call argument.

Parameters
txtwill be in undefined state

Definition at line 152 of file THttpCallArg.cxx.

◆ SetTopName()

void THttpCallArg::SetTopName ( const char *  topname)
inline

set engine-specific top-name

Definition at line 86 of file THttpCallArg.h.

◆ SetUserName()

void THttpCallArg::SetUserName ( const char *  n)
inline

set name of authenticated user

Definition at line 97 of file THttpCallArg.h.

◆ SetWSId()

void THttpCallArg::SetWSId ( UInt_t  id)
inline

set web-socket id

Definition at line 107 of file THttpCallArg.h.

◆ SetXml()

void THttpCallArg::SetXml ( )

Set content type as "text/xml".

Definition at line 161 of file THttpCallArg.cxx.

◆ SetXmlContent()

void THttpCallArg::SetXmlContent ( std::string &&  xml)

Set content type as "text/xml" and also assigns content After method call argument.

Parameters
xmlwill be in undefined state

Definition at line 170 of file THttpCallArg.cxx.

◆ SetZipping()

void THttpCallArg::SetZipping ( Int_t  mode = kZipLarge)
inline

Definition at line 206 of file THttpCallArg.h.

◆ TakeWSEngine()

std::shared_ptr< THttpWSEngine > THttpCallArg::TakeWSEngine ( )
private

takeout websocket handle with HTTP call can be done only once

Definition at line 249 of file THttpCallArg.cxx.

Friends And Related Function Documentation

◆ THttpServer

friend class THttpServer
friend

Definition at line 29 of file THttpCallArg.h.

◆ THttpWSEngine

friend class THttpWSEngine
friend

Definition at line 30 of file THttpCallArg.h.

◆ THttpWSHandler

friend class THttpWSHandler
friend

Definition at line 31 of file THttpCallArg.h.

Member Data Documentation

◆ fCond

std::condition_variable THttpCallArg::fCond
protected

! condition used to wait for processing

Definition at line 51 of file THttpCallArg.h.

◆ fContent

std::string THttpCallArg::fContent
private

! content - text or binary

Definition at line 70 of file THttpCallArg.h.

◆ fContentType

TString THttpCallArg::fContentType
protected

! type of content

Definition at line 53 of file THttpCallArg.h.

◆ fFileName

TString THttpCallArg::fFileName
protected

! file name

Definition at line 45 of file THttpCallArg.h.

◆ fHeader

TString THttpCallArg::fHeader
protected

! response header like ContentEncoding, Cache-Control and so on

Definition at line 55 of file THttpCallArg.h.

◆ fMethod

TString THttpCallArg::fMethod
protected

! request method like GET or POST

Definition at line 43 of file THttpCallArg.h.

◆ fNotifyFlag

Bool_t THttpCallArg::fNotifyFlag {kFALSE}
protected

! indicate that notification called

Definition at line 58 of file THttpCallArg.h.

◆ fPathName

TString THttpCallArg::fPathName
protected

! item path

Definition at line 44 of file THttpCallArg.h.

◆ fPostData

std::string THttpCallArg::fPostData
private

! data received with post request - text - or binary

Definition at line 71 of file THttpCallArg.h.

◆ fQuery

TString THttpCallArg::fQuery
protected

! additional arguments

Definition at line 47 of file THttpCallArg.h.

◆ fRequestHeader

TString THttpCallArg::fRequestHeader
protected

! complete header, provided with request

Definition at line 54 of file THttpCallArg.h.

◆ fTopName

TString THttpCallArg::fTopName
protected

! top item name

Definition at line 42 of file THttpCallArg.h.

◆ fUserName

TString THttpCallArg::fUserName
protected

! authenticated user name (if any)

Definition at line 46 of file THttpCallArg.h.

◆ fWSEngine

std::shared_ptr<THttpWSEngine> THttpCallArg::fWSEngine
private

! web-socket engine, which supplied to run created web socket

Definition at line 68 of file THttpCallArg.h.

◆ fWSId

UInt_t THttpCallArg::fWSId {0}
protected

! websocket identifier, used in web-socket related operations

Definition at line 49 of file THttpCallArg.h.

◆ fZipping

Int_t THttpCallArg::fZipping {kNoZip}
protected

! indicate if and when content should be compressed

Definition at line 56 of file THttpCallArg.h.

Libraries for THttpCallArg:
[legend]

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