xrootd
Public Member Functions | Private Attributes | List of all members
XrdCl::Message Class Reference

The message representation used throughout the system. More...

#include <XrdClMessage.hh>

Inheritance diagram for XrdCl::Message:
Inheritance graph
[legend]
Collaboration diagram for XrdCl::Message:
Collaboration graph
[legend]

Public Member Functions

 Message (uint32_t size=0)
 Constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
bool IsMarshalled () const
 Check if the message is marshalled. More...
 
void SetIsMarshalled (bool isMarshalled)
 Set the marshalling status. More...
 
void SetDescription (const std::string &description)
 Set the description of the message. More...
 
const std::string & GetDescription () const
 Get the description of the message. More...
 
void SetSessionId (uint64_t sessionId)
 Set the session ID which this message is meant for. More...
 
uint64_t GetSessionId () const
 Get the session ID the message is meant for. More...
 
void SetVirtReqID (uint16_t virtReqID)
 Set virtual request ID for the message. More...
 
uint16_t GetVirtReqID ()
 Get virtual request ID for the message. More...
 
- Public Member Functions inherited from XrdCl::Buffer
 Buffer (uint32_t size=0)
 Constructor. More...
 
 Buffer (Buffer &&buffer)
 Move Constructor. More...
 
Bufferoperator= (Buffer &&buffer)
 Move assignment operator. More...
 
virtual ~Buffer ()
 Destructor. More...
 
const char * GetBuffer (uint32_t offset=0) const
 Get the message buffer. More...
 
char * GetBuffer (uint32_t offset=0)
 Get the message buffer. More...
 
void ReAllocate (uint32_t size)
 Reallocate the buffer to a new location of a given size. More...
 
void Free ()
 Free the buffer. More...
 
void Allocate (uint32_t size)
 Allocate the buffer. More...
 
void Zero ()
 Zero. More...
 
uint32_t GetSize () const
 Get the size of the message. More...
 
uint32_t GetCursor () const
 Get append cursor. More...
 
void SetCursor (uint32_t cursor)
 Set the cursor. More...
 
void AdvanceCursor (uint32_t delta)
 Advance the cursor. More...
 
void Append (const char *buffer, uint32_t size)
 Append data at the position pointed to by the append cursor. More...
 
void Append (const char *buffer, uint32_t size, uint32_t offset)
 Append data at the given offset. More...
 
char * GetBufferAtCursor ()
 Get the buffer pointer at the append cursor. More...
 
const char * GetBufferAtCursor () const
 Get the buffer pointer at the append cursor. More...
 
void FromString (const std::string str)
 Fill the buffer from a string. More...
 
std::string ToString () const
 Convert the buffer to a string. More...
 
void Grab (char *buffer, uint32_t size)
 Grab a buffer allocated outside. More...
 
char * Release ()
 Release the buffer. More...
 

Private Attributes

bool pIsMarshalled
 
uint64_t pSessionId
 
std::string pDescription
 
uint16_t pVirtReqID
 

Detailed Description

The message representation used throughout the system.

Constructor & Destructor Documentation

◆ Message()

XrdCl::Message::Message ( uint32_t  size = 0)
inline

Constructor.

References XrdCl::Buffer::Zero().

◆ ~Message()

virtual XrdCl::Message::~Message ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ GetDescription()

const std::string& XrdCl::Message::GetDescription ( ) const
inline

Get the description of the message.

References pDescription.

Referenced by XrdCl::XRootDMsgHandler::XRootDMsgHandler().

◆ GetSessionId()

uint64_t XrdCl::Message::GetSessionId ( ) const
inline

Get the session ID the message is meant for.

References pSessionId.

Referenced by XrdCl::XRootDMsgHandler::XRootDMsgHandler().

◆ GetVirtReqID()

uint16_t XrdCl::Message::GetVirtReqID ( )
inline

Get virtual request ID for the message.

References pVirtReqID.

◆ IsMarshalled()

bool XrdCl::Message::IsMarshalled ( ) const
inline

Check if the message is marshalled.

References pIsMarshalled.

◆ SetDescription()

void XrdCl::Message::SetDescription ( const std::string &  description)
inline

Set the description of the message.

References pDescription.

◆ SetIsMarshalled()

void XrdCl::Message::SetIsMarshalled ( bool  isMarshalled)
inline

Set the marshalling status.

References pIsMarshalled.

◆ SetSessionId()

void XrdCl::Message::SetSessionId ( uint64_t  sessionId)
inline

Set the session ID which this message is meant for.

References pSessionId.

◆ SetVirtReqID()

void XrdCl::Message::SetVirtReqID ( uint16_t  virtReqID)
inline

Set virtual request ID for the message.

References pVirtReqID.

Member Data Documentation

◆ pDescription

std::string XrdCl::Message::pDescription
private

Referenced by GetDescription(), and SetDescription().

◆ pIsMarshalled

bool XrdCl::Message::pIsMarshalled
private

Referenced by IsMarshalled(), and SetIsMarshalled().

◆ pSessionId

uint64_t XrdCl::Message::pSessionId
private

Referenced by GetSessionId(), and SetSessionId().

◆ pVirtReqID

uint16_t XrdCl::Message::pVirtReqID
private

Referenced by GetVirtReqID(), and SetVirtReqID().


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