xrootd: XrdCl::Buffer Class Reference

Binary blob representation. More...

#include <XrdClBuffer.hh>

Inheritance diagram for XrdCl::Buffer:

Inheritance graph

Public Member Functions
	Buffer (uint32_t size=0)
	Constructor. More...

	Buffer (Buffer &&buffer)
	Move Constructor. More...

Buffer &	operator= (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...

Protected Member Functions
void	Steal (Buffer &&buffer)

Private Member Functions
	Buffer (const Buffer &)

Buffer &	operator= (const Buffer &)

Private Attributes
char *	pBuffer

uint32_t	pSize

uint32_t	pCursor

Detailed Description

Binary blob representation.

Constructor & Destructor Documentation

XrdCl::Buffer::Buffer ( uint32_t size = 0 )

inline

Constructor.

References Allocate().

XrdCl::Buffer::Buffer ( Buffer && buffer )

inline

Move Constructor.

References Steal().

virtual XrdCl::Buffer::~Buffer ( )

inlinevirtual

Destructor.

References Free().

XrdCl::Buffer::Buffer ( const Buffer & )

private

Member Function Documentation

void XrdCl::Buffer::AdvanceCursor ( uint32_t delta )

inline

Advance the cursor.

References pCursor.

Referenced by XrdEc::WrtBuff::Pad(), and XrdEc::WrtBuff::Write().

void XrdCl::Buffer::Allocate ( uint32_t size )

inline

Allocate the buffer.

References pBuffer, and pSize.

Referenced by Buffer(), and XrdEc::WrtBuff::Pad().

void XrdCl::Buffer::Append	(	const char *	buffer,
		uint32_t	size
	)

inline

Append data at the position pointed to by the append cursor.

References pBuffer, pCursor, pSize, and ReAllocate().

Referenced by XrdCl::MessageUtils::CreateXAttrBody().

void XrdCl::Buffer::Append	(	const char *	buffer,
		uint32_t	size,
		uint32_t	offset
	)

inline

Append data at the given offset.

References pBuffer, pSize, and ReAllocate().

void XrdCl::Buffer::Free ( )

inline

Free the buffer.

References pBuffer, pCursor, and pSize.

Referenced by Grab(), and ~Buffer().

void XrdCl::Buffer::FromString ( const std::string str )

inline

Fill the buffer from a string.

References pBuffer, and ReAllocate().

Referenced by XrdCl::EcHandler::Close().

const char* XrdCl::Buffer::GetBuffer ( uint32_t offset = 0 ) const

inline

Get the message buffer.

References pBuffer.

Referenced by XrdCl::MessageUtils::CreateRequest(), XrdCl::MessageUtils::CreateXAttrBody(), XrdEc::WrtBuff::Encode(), GetBufferAtCursor(), XrdCl::XRootDTransport::MarshallRequest(), XrdEc::WrtBuff::Pad(), XrdCl::XRootDTransport::SetDescription(), XrdEc::WrtBuff::WrtBuff(), and XrdCl::XRootDMsgHandler::XRootDMsgHandler().

char* XrdCl::Buffer::GetBuffer ( uint32_t offset = 0 )

inline

Get the message buffer.

References pBuffer.

char* XrdCl::Buffer::GetBufferAtCursor ( )

inline

Get the buffer pointer at the append cursor.

References GetBuffer(), and pCursor.

Referenced by XrdEc::WrtBuff::Write().

const char* XrdCl::Buffer::GetBufferAtCursor ( ) const

inline

Get the buffer pointer at the append cursor.

References GetBuffer(), and pCursor.

uint32_t XrdCl::Buffer::GetCursor ( ) const

inline

Get append cursor.

References pCursor.

Referenced by XrdEc::WrtBuff::Complete(), XrdEc::WrtBuff::Empty(), XrdEc::WrtBuff::GetBlkSize(), XrdEc::WrtBuff::GetStrpSize(), and XrdEc::WrtBuff::Write().

uint32_t XrdCl::Buffer::GetSize ( ) const

inline

Get the size of the message.

References pSize.

Referenced by XrdEc::WrtBuff::Empty(), XrdEc::WrtBuff::Pad(), XrdCl::FcntlAction::Serialize(), XrdCl::AsyncMsgWriter::Write(), and XrdEc::WrtBuff::WrtBuff().

void XrdCl::Buffer::Grab	(	char *	buffer,
		uint32_t	size
	)

inline

Grab a buffer allocated outside.

References Free(), pBuffer, and pSize.

Buffer& XrdCl::Buffer::operator= ( Buffer && buffer )

inline

Move assignment operator.

References Steal().

Buffer& XrdCl::Buffer::operator= ( const Buffer & )

private

void XrdCl::Buffer::ReAllocate ( uint32_t size )

inline

Reallocate the buffer to a new location of a given size.

References pBuffer, and pSize.

Referenced by Append(), and FromString().

char* XrdCl::Buffer::Release ( )

inline

Release the buffer.

References pBuffer, pCursor, and pSize.

void XrdCl::Buffer::SetCursor ( uint32_t cursor )

inline

Set the cursor.

References pCursor.

Referenced by XrdEc::WrtBuff::Pad(), and XrdCl::AsyncMsgWriter::Write().

void XrdCl::Buffer::Steal ( Buffer && buffer )

inlineprotected

References pBuffer, pCursor, and pSize.

Referenced by Buffer(), XrdCl::Message::operator=(), and operator=().

std::string XrdCl::Buffer::ToString ( ) const

inline

Convert the buffer to a string.

References pBuffer, and pSize.

void XrdCl::Buffer::Zero ( )

inline

Zero.

References pBuffer, and pSize.

Referenced by XrdCl::MessageUtils::CreateRequest(), and XrdCl::Message::Message().

Member Data Documentation

char* XrdCl::Buffer::pBuffer

private

Referenced by Allocate(), Append(), Free(), FromString(), GetBuffer(), Grab(), ReAllocate(), Release(), Steal(), ToString(), and Zero().

uint32_t XrdCl::Buffer::pCursor

private

Referenced by AdvanceCursor(), Append(), Free(), GetBufferAtCursor(), GetCursor(), Release(), SetCursor(), and Steal().

uint32_t XrdCl::Buffer::pSize

private

Referenced by Allocate(), Append(), Free(), GetSize(), Grab(), ReAllocate(), Release(), Steal(), ToString(), and Zero().

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

XrdClBuffer.hh