ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
THttpCallArg Class Reference

Definition at line 22 of file THttpCallArg.h.

Public Member Functions

 THttpCallArg ()
 
 ~THttpCallArg ()
 destructor More...
 
void SetMethod (const char *method)
 
void SetTopName (const char *topname)
 
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)
 
void SetFileName (const char *f)
 
void SetUserName (const char *n)
 
void SetQuery (const char *q)
 
void SetPostData (void *data, Long_t length)
 set data, posted with the request buffer should be allocated with malloc(length+1) call, while last byte will be set to 0 Than one could use post data as null-terminated string More...
 
void SetRequestHeader (const char *h)
 
Int_t NumRequestHeader () const
 
TString GetRequestHeaderName (Int_t number) const
 
TString GetRequestHeader (const char *name)
 
const char * GetTopName () const
 
const char * GetMethod () const
 
Bool_t IsPostMethod () const
 
voidGetPostData () const
 
Long_t GetPostDataLength () const
 
const char * GetPathName () const
 
const char * GetFileName () const
 
const char * GetUserName () const
 
const char * GetQuery () const
 
void SetContentType (const char *typ)
 
void Set404 ()
 
void SetFile (const char *filename=0)
 
void SetXml ()
 
void SetJson ()
 
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...
 
Int_t NumHeader () const
 
TString GetHeaderName (Int_t number) const
 
TString GetHeader (const char *name)
 return specified header More...
 
void SetEncoding (const char *typ)
 
void SetContent (const char *c)
 
Bool_t CompressWithGzip ()
 compress reply data with gzip compression More...
 
void SetZipping (Int_t kind)
 
Int_t GetZipping () const
 
void SetExtraHeader (const char *name, const char *value)
 
void FillHttpHeader (TString &buf, const char *header=0)
 fill HTTP header More...
 
Bool_t IsContentType (const char *typ) const
 
Bool_t Is404 () const
 
Bool_t IsFile () const
 
const char * GetContentType () const
 
void SetBinData (void *data, Long_t length)
 set binary data, which will be returned as reply body More...
 
Long_t GetContentLength () const
 
const voidGetContent () const
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. 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...
 
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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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 IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. 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)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

Bool_t IsBinData () const
 length of binary data More...
 
TString AccessHeader (TString &buf, const char *name, const char *value=0, Bool_t doing_set=kFALSE)
 method used to get or set http header in the string buffer Header has following format: field1 : value1
field2 : value2
Such format corresponds to header format in HTTP requests 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
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

TString fTopName
 
TString fMethod
 top item name More...
 
TString fPathName
 request method like GET or POST More...
 
TString fFileName
 item path More...
 
TString fUserName
 file name More...
 
TString fQuery
 authenticated user name (if any) More...
 
voidfPostData
 additional arguments More...
 
Long_t fPostDataLength
 binary data received with post request More...
 
TCondition fCond
 length of binary data More...
 
TString fContentType
 condition used to wait for processing More...
 
TString fRequestHeader
 type of content More...
 
TString fHeader
 complete header, provided with request More...
 
TString fContent
 response header like ContentEncoding, Cache-Control and so on More...
 
Int_t fZipping
 text content (if any) More...
 
voidfBinData
 indicate if content should be zipped More...
 
Long_t fBinDataLength
 binary data, assigned with http call More...
 

Friends

class THttpServer
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat 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:
+ Collaboration diagram for THttpCallArg:

Constructor & Destructor Documentation

THttpCallArg::THttpCallArg ( )
THttpCallArg::~THttpCallArg ( )

destructor

Definition at line 47 of file THttpCallArg.cxx.

Member Function Documentation

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

method used to get or set http header in the string buffer Header has following format: field1 : value1
field2 : value2
Such format corresponds to header format in HTTP requests

Definition at line 67 of file THttpCallArg.cxx.

Referenced by AddHeader(), GetHeader(), GetRequestHeader(), and SetEncoding().

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 203 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), THttpServer::ProcessRequest(), and SetExtraHeader().

Bool_t THttpCallArg::CompressWithGzip ( )

compress reply data with gzip compression

Definition at line 240 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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 109 of file THttpCallArg.cxx.

Referenced by GetHeaderName(), GetRequestHeaderName(), NumHeader(), and NumRequestHeader().

void THttpCallArg::FillHttpHeader ( TString buf,
const char *  header = 0 
)

fill HTTP header

Definition at line 216 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), and TFastCgi::run_func().

const void* THttpCallArg::GetContent ( ) const
inline

Definition at line 328 of file THttpCallArg.h.

Referenced by begin_request_handler(), CompressWithGzip(), and TFastCgi::run_func().

Long_t THttpCallArg::GetContentLength ( ) const
inline
const char* THttpCallArg::GetContentType ( ) const
inline

Definition at line 316 of file THttpCallArg.h.

Referenced by FillHttpHeader().

const char* THttpCallArg::GetFileName ( ) const
inline

Definition at line 180 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

TString THttpCallArg::GetHeader ( const char *  name)

return specified header

Definition at line 188 of file THttpCallArg.cxx.

TString THttpCallArg::GetHeaderName ( Int_t  number) const
inline

Definition at line 248 of file THttpCallArg.h.

const char* THttpCallArg::GetMethod ( ) const
inline

Definition at line 145 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

const char* THttpCallArg::GetPathName ( ) const
inline

Definition at line 173 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

void* THttpCallArg::GetPostData ( ) const
inline

Definition at line 159 of file THttpCallArg.h.

Referenced by TRootSniffer::ProduceExe(), and TRootSniffer::ProduceMulti().

Long_t THttpCallArg::GetPostDataLength ( ) const
inline
const char* THttpCallArg::GetQuery ( ) const
inline

Definition at line 194 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 131 of file THttpCallArg.h.

Referenced by TFastCgi::run_func().

TString THttpCallArg::GetRequestHeaderName ( Int_t  number) const
inline

Definition at line 124 of file THttpCallArg.h.

const char* THttpCallArg::GetTopName ( ) const
inline

Definition at line 138 of file THttpCallArg.h.

const char* THttpCallArg::GetUserName ( ) const
inline
Int_t THttpCallArg::GetZipping ( ) const
inline

Definition at line 284 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

Bool_t THttpCallArg::Is404 ( ) const
inline
Bool_t THttpCallArg::IsBinData ( ) const
inlineprotected

length of binary data

Definition at line 48 of file THttpCallArg.h.

Referenced by GetContent(), and GetContentLength().

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

Definition at line 301 of file THttpCallArg.h.

Referenced by Is404(), and IsFile().

Bool_t THttpCallArg::IsFile ( ) const
inline

Definition at line 311 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

Bool_t THttpCallArg::IsPostMethod ( ) const
inline

Definition at line 152 of file THttpCallArg.h.

Int_t THttpCallArg::NumHeader ( ) const
inline

Definition at line 241 of file THttpCallArg.h.

Int_t THttpCallArg::NumRequestHeader ( ) const
inline

Definition at line 117 of file THttpCallArg.h.

void THttpCallArg::Set404 ( )
inline

Definition at line 210 of file THttpCallArg.h.

Referenced by begin_request_handler(), and THttpServer::ProcessRequest().

void THttpCallArg::SetBinData ( void data,
Long_t  length 
)

set binary data, which will be returned as reply body

Definition at line 151 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), CompressWithGzip(), and THttpServer::ProcessRequest().

void THttpCallArg::SetContent ( const char *  c)
inline

Definition at line 264 of file THttpCallArg.h.

Referenced by begin_request_handler().

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

Definition at line 257 of file THttpCallArg.h.

Referenced by CompressWithGzip().

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

Definition at line 291 of file THttpCallArg.h.

Referenced by TRootSniffer::ProduceBinary(), and TRootSniffer::ProduceExe().

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

Definition at line 217 of file THttpCallArg.h.

Referenced by begin_request_handler(), and THttpServer::ProcessRequest().

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

Definition at line 87 of file THttpCallArg.h.

void THttpCallArg::SetJson ( )
inline

Definition at line 232 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest().

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

Definition at line 64 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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 167 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 80 of file THttpCallArg.h.

void THttpCallArg::SetPostData ( void data,
Long_t  length 
)

set data, posted with the request buffer should be allocated with malloc(length+1) call, while last byte will be set to 0 Than one could use post data as null-terminated string

Definition at line 140 of file THttpCallArg.cxx.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 101 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 110 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 71 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

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

Definition at line 94 of file THttpCallArg.h.

Referenced by begin_request_handler(), and TFastCgi::run_func().

void THttpCallArg::SetXml ( )
inline

Definition at line 225 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest().

void THttpCallArg::SetZipping ( Int_t  kind)
inline

Definition at line 273 of file THttpCallArg.h.

Referenced by begin_request_handler(), and THttpServer::ProcessRequest().

Friends And Related Function Documentation

friend class THttpServer
friend

Definition at line 25 of file THttpCallArg.h.

Member Data Documentation

void* THttpCallArg::fBinData
protected

indicate if content should be zipped

Definition at line 45 of file THttpCallArg.h.

Referenced by SetBinData(), and ~THttpCallArg().

Long_t THttpCallArg::fBinDataLength
protected

binary data, assigned with http call

Definition at line 46 of file THttpCallArg.h.

Referenced by SetBinData().

TCondition THttpCallArg::fCond
protected

length of binary data

Definition at line 37 of file THttpCallArg.h.

Referenced by THttpServer::ExecuteHttp(), and THttpServer::ProcessRequests().

TString THttpCallArg::fContent
protected

response header like ContentEncoding, Cache-Control and so on

Definition at line 42 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest(), and SetBinData().

TString THttpCallArg::fContentType
protected

condition used to wait for processing

Definition at line 39 of file THttpCallArg.h.

Referenced by FillHttpHeader(), and GetHeader().

TString THttpCallArg::fFileName
protected

item path

Definition at line 30 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest(), and SetPathAndFileName().

TString THttpCallArg::fHeader
protected

complete header, provided with request

Definition at line 41 of file THttpCallArg.h.

Referenced by AddHeader(), FillHttpHeader(), and GetHeader().

TString THttpCallArg::fMethod
protected

top item name

Definition at line 28 of file THttpCallArg.h.

TString THttpCallArg::fPathName
protected

request method like GET or POST

Definition at line 29 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest(), and SetPathAndFileName().

void* THttpCallArg::fPostData
protected

additional arguments

Definition at line 34 of file THttpCallArg.h.

Referenced by GetPostData(), SetPostData(), and ~THttpCallArg().

Long_t THttpCallArg::fPostDataLength
protected

binary data received with post request

Definition at line 35 of file THttpCallArg.h.

Referenced by GetPostDataLength(), and SetPostData().

TString THttpCallArg::fQuery
protected

authenticated user name (if any)

Definition at line 32 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest().

TString THttpCallArg::fRequestHeader
protected

type of content

Definition at line 40 of file THttpCallArg.h.

TString THttpCallArg::fTopName
protected

Definition at line 27 of file THttpCallArg.h.

Referenced by THttpServer::ProcessRequest().

TString THttpCallArg::fUserName
protected

file name

Definition at line 31 of file THttpCallArg.h.

Int_t THttpCallArg::fZipping
protected

text content (if any)

Definition at line 43 of file THttpCallArg.h.

Referenced by GetZipping().


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