![]() |
XRootD
|
#include <XrdXrootdGStream.hh>
Public Member Functions | |
XrdXrootdGStream (XrdXrootdGSReal &gsRef) | |
void | Flush () |
uint32_t | GetDictID (const char *text, bool isPath=false) |
bool | HasHdr () |
bool | Insert (const char *data, int dlen) |
bool | Insert (int dlen) |
char * | Reserve (int dlen) |
int | SetAutoFlush (int afsec) |
int | Space () |
Static Public Attributes | |
static const int | MaxDataLen = 65280 |
The larest amount of data that can be inserted in a single call to GStream. More... | |
Protected Member Functions | |
~XrdXrootdGStream () | |
Destructor. This stream should never be directly deleted. More... | |
Definition at line 43 of file XrdXrootdGStream.hh.
|
inline |
Constructor
gsRef | refrence to the G-Stream implementation. |
Definition at line 158 of file XrdXrootdGStream.hh.
|
inlineprotected |
Destructor. This stream should never be directly deleted.
Definition at line 166 of file XrdXrootdGStream.hh.
void XrdXrootdGStream::Flush | ( | ) |
Flush any pending monitoring messages to the data collector. Also, see the related SetAutoFlush() method.
Definition at line 38 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::Flush().
uint32_t XrdXrootdGStream::GetDictID | ( | const char * | text, |
bool | isPath = false |
||
) |
Obtain a dictionary ID to map a string to an integer ID. The mapping is automatically sent to the monitor collector for future use using the 'd' or 'i' mapping identifier.
text | -> the null terminated string to be assigned an ID. The text must be less than or equal to 1024 characters. |
isPath | when true the text specified a file system path and identified as a XROOTD_MON_MAPPATH item. Otherwise, it is identified as a XROOTD_MON_MAPINFO item. |
Definition at line 44 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::GetDictID().
bool XrdXrootdGStream::HasHdr | ( | ) |
Check if payload is fronted by a header.
Definition at line 51 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::HasHdr().
bool XrdXrootdGStream::Insert | ( | const char * | data, |
int | dlen | ||
) |
Insert information into the G-Stream.
data | -> to null-terminated text to be included in the G-Stream. |
dlen | the length of the text including the null character. Requires that (8 <= dlen <= MaxDataLen); defined below. |
Definition at line 58 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::Insert().
Referenced by XrdXrootdTpcMon::Report().
bool XrdXrootdGStream::Insert | ( | int | dlen | ) |
Insert information into the G-Stream using the data placed in the buffer space obtained by a previous call to Reserve(). Upon return, this object is unlocked.
dlen | the number of bytes actually present in the buffer. The text must end with a null byte and dlen must be 8 <= dlen <= dlen used in the previous Reserve() call. |
Definition at line 61 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::Insert().
char * XrdXrootdGStream::Reserve | ( | int | dlen | ) |
Obtain a buffer space for information. This object is locked and no other thread can insert information until the buffer is inserted using Insert().
dlen | the number of bytes required to be available for use. Requires that (8 <= dlen <= MaxDataLen); defined below. |
Definition at line 67 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::Reserve().
int XrdXrootdGStream::SetAutoFlush | ( | int | afsec | ) |
Set autoflush time interval (or disable it). Disabling autoflush may be useful when data is periodically generated at a low rate and manual flushing would produce more consistent results.
afsec | Number of seconds between autoflushing. A zero or negative value disables autoflush. The default is 600 seconds (i.e. 10 minutes) subject to what is specified via the xrootd.monitor flush directive. Positive values less that 60 are considered to be 60. |
Definition at line 73 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::SetAutoFlush().
int XrdXrootdGStream::Space | ( | ) |
Get the amount of buffer space remaining.
Definition at line 83 of file XrdXrootdGStream.cc.
References XrdXrootdGSReal::Space().
|
static |
The larest amount of data that can be inserted in a single call to GStream.
Definition at line 150 of file XrdXrootdGStream.hh.
Referenced by XrdXrootdGSReal::Insert(), and XrdXrootdGSReal::Reserve().