#include <XrdXrootdGStream.hh>
|
| static const int | MaxDataLen = 65280 |
| | The larest amount of data that can be inserted in a single call to GStream.
|
| |
◆ XrdXrootdGStream()
Constructor
- Parameters
-
| gsRef | refrence to the G-Stream implementation. |
◆ ~XrdXrootdGStream()
| XrdXrootdGStream::~XrdXrootdGStream |
( |
| ) |
|
|
inlineprotected |
Destructor. This stream should never be directly deleted.
◆ Flush()
| void XrdXrootdGStream::Flush |
( |
| ) |
|
Flush any pending monitoring messages to the data collector. Also, see the related SetAutoFlush() method.
◆ GetDictID()
| 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.
- Parameters
-
| 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. |
- Returns
- the integer identifier assigned to the string information. The returned value is in network byte order!
◆ HasHdr()
| bool XrdXrootdGStream::HasHdr |
( |
| ) |
|
Check if payload is fronted by a header.
- Returns
- true payload is fronted by a header.
-
false payload is not fronted by a header. GetDictID() mappings are not sent and must be manually included inline.
◆ Insert() [1/2]
| bool XrdXrootdGStream::Insert |
( |
const char * |
data, |
|
|
int |
dlen |
|
) |
| |
Insert information into the G-Stream.
- Parameters
-
| 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. |
- Returns
- true data included.
-
false data rejected; invalid length or is not null terminated.
◆ Insert() [2/2]
| 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.
- Parameters
-
| 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. |
- Returns
- true data included.
-
false data rejected; invalid length or no buffer outstanding.
◆ Reserve()
| 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().
- Parameters
-
| dlen | the number of bytes required to be available for use. Requires that (8 <= dlen <= MaxDataLen); defined below. |
- Returns
- !0 pointer to a dlen sized buffer.
-
=0 invalid length specified or a buffer is outstanding.
◆ SetAutoFlush()
| 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.
- Parameters
-
| 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. |
- Returns
- The previous auto-flush setting.
◆ Space()
| int XrdXrootdGStream::Space |
( |
| ) |
|
Get the amount of buffer space remaining.
- Returns
- The maximum number of bytes that can be inserted at time of call.
◆ gStream
◆ MaxDataLen
| const int XrdXrootdGStream::MaxDataLen = 65280 |
|
static |
The larest amount of data that can be inserted in a single call to GStream.
The documentation for this class was generated from the following file:
