#include <TBufferTransports.h>

Inheritance diagram for contrail::sandesh::transport::TMemoryBuffer:

Collaboration diagram for contrail::sandesh::transport::TMemoryBuffer:

Public Types
enum	MemoryPolicy { OBSERVE = 1, COPY = 2, TAKE_OWNERSHIP = 3 }

Public Member Functions
	TMemoryBuffer ()

	TMemoryBuffer (uint32_t sz)

	TMemoryBuffer (uint8_t *buf, uint32_t sz, MemoryPolicy policy=OBSERVE)

	~TMemoryBuffer ()

bool	isOpen ()

bool	peek ()

void	open ()

void	close ()

void	getBuffer (uint8_t *bufPtr, uint32_t sz)

std::string	getBufferAsString ()

void	appendBufferToString (std::string &str)

void	resetBuffer ()

void	resetBuffer (uint8_t *buf, uint32_t sz, MemoryPolicy policy=OBSERVE)
	See constructor documentation. More...

void	resetBuffer (uint32_t sz)
	See constructor documentation. More...

std::string	readAsString (uint32_t len)

uint32_t	readAppendToString (std::string &str, uint32_t len)

uint32_t	readEnd ()

uint32_t	writeEnd ()

uint32_t	available_read () const

uint32_t	available_write () const

uint8_t *	getWritePtr (uint32_t len)

void	wroteBytes (uint32_t len)

uint32_t	readAll (uint8_t *buf, uint32_t len)

Public Member Functions inherited from contrail::sandesh::transport::TVirtualTransport< TMemoryBuffer, TBufferBase >
virtual int32_t	read_virt (uint8_t *buf, uint32_t len)

virtual int32_t	readAll_virt (uint8_t *buf, uint32_t len)

virtual int	write_virt (const uint8_t *buf, uint32_t len)

virtual const uint8_t *	borrow_virt (uint8_t buf, uint32_t len)

virtual void	consume_virt (uint32_t len)

uint32_t	readAll (uint8_t *buf, uint32_t len)

Public Member Functions inherited from contrail::sandesh::transport::TBufferBase
int32_t	read (uint8_t *buf, uint32_t len)

int32_t	readAll (uint8_t *buf, uint32_t len)

int	write (const uint8_t *buf, uint32_t len)

const uint8_t *	borrow (uint8_t buf, uint32_t len)

void	consume (uint32_t len)

void	setReadBuffer (uint8_t *buf, uint32_t len)
	Convenience mutator for setting the read buffer. More...

void	setWriteBuffer (uint8_t *buf, uint32_t len)
	Convenience mutator for setting the write buffer. More...

Public Member Functions inherited from contrail::sandesh::transport::TVirtualTransport< TBufferBase >
uint32_t	readAll (uint8_t *buf, uint32_t len)

Public Member Functions inherited from contrail::sandesh::transport::TTransportDefaults
uint32_t	read (uint8_t *buf, uint32_t len)

uint32_t	readAll (uint8_t *buf, uint32_t len)

int	write (const uint8_t *buf, uint32_t len)

const uint8_t *	borrow (uint8_t buf, uint32_t len)

void	consume (uint32_t len)

Public Member Functions inherited from contrail::sandesh::transport::TTransport
virtual	~TTransport ()

int32_t	read (uint8_t *buf, uint32_t len)

int32_t	readAll (uint8_t *buf, uint32_t len)

int	write (const uint8_t *buf, uint32_t len)

virtual void	flush ()

const uint8_t *	borrow (uint8_t buf, uint32_t len)

void	consume (uint32_t len)

Static Public Attributes
static const uint32_t	defaultSize = 1024

Protected Member Functions
void	swap (TMemoryBuffer &that)

int	ensureCanWrite (uint32_t len)

void	computeRead (uint32_t len, uint8_t *out_start, uint32_t out_give)

uint32_t	readSlow (uint8_t *buf, uint32_t len)
	Slow path read. More...

int	writeSlow (const uint8_t *buf, uint32_t len)
	Slow path write. More...

const uint8_t *	borrowSlow (uint8_t buf, uint32_t len)

Protected Member Functions inherited from contrail::sandesh::transport::TVirtualTransport< TMemoryBuffer, TBufferBase >
	TVirtualTransport ()

	TVirtualTransport (Arg_ const &arg)

	TVirtualTransport (Arg1_ const &a1, Arg2_ const &a2)

Protected Member Functions inherited from contrail::sandesh::transport::TBufferBase
	TBufferBase ()

virtual	~TBufferBase ()

Protected Member Functions inherited from contrail::sandesh::transport::TVirtualTransport< TBufferBase >
	TVirtualTransport ()

	TVirtualTransport (Arg_ const &arg)

	TVirtualTransport (Arg1_ const &a1, Arg2_ const &a2)

Protected Member Functions inherited from contrail::sandesh::transport::TTransportDefaults
	TTransportDefaults ()

Protected Member Functions inherited from contrail::sandesh::transport::TTransport
	TTransport ()

Protected Attributes
uint8_t *	buffer_

uint32_t	bufferSize_

bool	owner_

Protected Attributes inherited from contrail::sandesh::transport::TBufferBase
uint8_t *	rBase_
	Reads begin here. More...

uint8_t *	rBound_
	Reads may extend to just before here. More...

uint8_t *	wBase_
	Writes begin here. More...

uint8_t *	wBound_
	Writes may extend to just before here. More...

Private Member Functions
void	initCommon (uint8_t *buf, uint32_t size, bool owner, uint32_t wPos)

Detailed Description

A memory buffer is a tranpsort that simply reads from and writes to an in memory buffer. Anytime you call write on it, the data is simply placed into a buffer, and anytime you call read, data is read from that buffer.

The buffers are allocated using C constructs malloc,realloc, and the size doubles as necessary. We've considered using scoped

Definition at line 192 of file TBufferTransports.h.

Member Enumeration Documentation

enum contrail::sandesh::transport::TMemoryBuffer::MemoryPolicy

This enum specifies how a TMemoryBuffer should treat memory passed to it via constructors or resetBuffer.

OBSERVE: TMemoryBuffer will simply store a pointer to the memory. It is the callers responsibility to ensure that the pointer remains valid for the lifetime of the TMemoryBuffer, and that it is properly cleaned up. Note that no data can be written to observed buffers.

COPY: TMemoryBuffer will make an internal copy of the buffer. The caller has no responsibilities.

TAKE_OWNERSHIP: TMemoryBuffer will become the "owner" of the buffer, and will be responsible for freeing it. The membory must have been allocated with malloc.

Enumerator
OBSERVE
COPY
TAKE_OWNERSHIP

Definition at line 244 of file TBufferTransports.h.

Constructor & Destructor Documentation

contrail::sandesh::transport::TMemoryBuffer::TMemoryBuffer ( )

inline

Construct a TMemoryBuffer with a default-sized buffer, owned by the TMemoryBuffer object.

Definition at line 254 of file TBufferTransports.h.

Here is the call graph for this function:

contrail::sandesh::transport::TMemoryBuffer::TMemoryBuffer ( uint32_t sz )

inline

Construct a TMemoryBuffer with a buffer of a specified size, owned by the TMemoryBuffer object.

Parameters

sz	The initial size of the buffer.

Definition at line 264 of file TBufferTransports.h.

Here is the call graph for this function:

contrail::sandesh::transport::TMemoryBuffer::TMemoryBuffer	(	uint8_t *	buf,
		uint32_t	sz,
		MemoryPolicy	policy = `OBSERVE`
	)

inline

Construct a TMemoryBuffer with buf as its initial contents.

Parameters

buf	The initial contents of the buffer. Note that, while buf is a non-const pointer, TMemoryBuffer will not write to it if policy == OBSERVE, so it is safe to const_cast<uint8_t*>(whatever).
sz	The size of `buf`.
policy	See MemoryPolicy .

Definition at line 278 of file TBufferTransports.h.

Here is the call graph for this function:

contrail::sandesh::transport::TMemoryBuffer::~TMemoryBuffer ( )

inline

Definition at line 300 of file TBufferTransports.h.

Member Function Documentation

void contrail::sandesh::transport::TMemoryBuffer::appendBufferToString ( std::string & str )

inline

Definition at line 334 of file TBufferTransports.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TMemoryBuffer::available_read ( ) const

inline

Definition at line 407 of file TBufferTransports.h.

uint32_t contrail::sandesh::transport::TMemoryBuffer::available_write ( ) const

inline

Definition at line 412 of file TBufferTransports.h.

const uint8_t* contrail::sandesh::transport::TMemoryBuffer::borrowSlow	(	uint8_t *	buf,
		uint32_t *	len
	)

protectedvirtual

Slow path borrow.

POSTCONDITION: return == NULL || rBound_ - rBase_ >= *len

Implements contrail::sandesh::transport::TBufferBase.

void contrail::sandesh::transport::TMemoryBuffer::close ( )

inlinevirtual

Closes the transport.

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 316 of file TBufferTransports.h.

void contrail::sandesh::transport::TMemoryBuffer::computeRead	(	uint32_t	len,
		uint8_t **	out_start,
		uint32_t *	out_give
	)

protected

int contrail::sandesh::transport::TMemoryBuffer::ensureCanWrite ( uint32_t len )

protected

void contrail::sandesh::transport::TMemoryBuffer::getBuffer	(	uint8_t **	bufPtr,
		uint32_t *	sz
	)

inline

Definition at line 319 of file TBufferTransports.h.

std::string contrail::sandesh::transport::TMemoryBuffer::getBufferAsString ( )

inline

Definition at line 324 of file TBufferTransports.h.

Here is the call graph for this function:

uint8_t* contrail::sandesh::transport::TMemoryBuffer::getWritePtr ( uint32_t len )

inline

Definition at line 421 of file TBufferTransports.h.

Here is the call graph for this function:

void contrail::sandesh::transport::TMemoryBuffer::initCommon	(	uint8_t *	buf,
		uint32_t	size,
		bool	owner,
		uint32_t	wPos
	)

inlineprivate

Definition at line 196 of file TBufferTransports.h.

bool contrail::sandesh::transport::TMemoryBuffer::isOpen ( )

inlinevirtual

Whether this transport is open.

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 306 of file TBufferTransports.h.

void contrail::sandesh::transport::TMemoryBuffer::open ( )

inlinevirtual

Opens the transport for communications.

Returns: bool Whether the transport was successfully opened

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 314 of file TBufferTransports.h.

bool contrail::sandesh::transport::TMemoryBuffer::peek ( )

inlinevirtual

Tests whether there is more data to read or if the remote side is still open. By default this is true whenever the transport is open, but implementations should add logic to test for this condition where possible (i.e. on a socket). This is used by a server to check if it should listen for another request.

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 310 of file TBufferTransports.h.

uint32_t contrail::sandesh::transport::TMemoryBuffer::readAll	(	uint8_t *	buf,
		uint32_t	len
	)

inline

Definition at line 434 of file TBufferTransports.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TMemoryBuffer::readAppendToString	(	std::string &	str,
		uint32_t	len
	)

std::string contrail::sandesh::transport::TMemoryBuffer::readAsString ( uint32_t len )

inline

Definition at line 385 of file TBufferTransports.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TMemoryBuffer::readEnd ( )

inlinevirtual

Called when read is completed. This can be over-ridden to perform a transport-specific action e.g. logging the request to a file

Returns: number of bytes read if available, 0 otherwise.

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 394 of file TBufferTransports.h.

Here is the call graph for this function:

uint32_t contrail::sandesh::transport::TMemoryBuffer::readSlow	(	uint8_t *	buf,
		uint32_t	len
	)

protectedvirtual

Slow path read.

Implements contrail::sandesh::transport::TBufferBase.

void contrail::sandesh::transport::TMemoryBuffer::resetBuffer ( )

inline

Definition at line 344 of file TBufferTransports.h.

void contrail::sandesh::transport::TMemoryBuffer::resetBuffer	(	uint8_t *	buf,
		uint32_t	sz,
		MemoryPolicy	policy = `OBSERVE`
	)

inline

See constructor documentation.

Definition at line 356 of file TBufferTransports.h.

Here is the call graph for this function:

void contrail::sandesh::transport::TMemoryBuffer::resetBuffer ( uint32_t sz )

inline

See constructor documentation.

Definition at line 377 of file TBufferTransports.h.

Here is the call graph for this function:

void contrail::sandesh::transport::TMemoryBuffer::swap ( TMemoryBuffer & that )

inlineprotected

Definition at line 439 of file TBufferTransports.h.

uint32_t contrail::sandesh::transport::TMemoryBuffer::writeEnd ( )

inlinevirtual

Called when write is completed. This can be over-ridden to perform a transport-specific action at the end of a request.

Returns: number of bytes written if available, 0 otherwise

Reimplemented from contrail::sandesh::transport::TTransport.

Definition at line 403 of file TBufferTransports.h.

int contrail::sandesh::transport::TMemoryBuffer::writeSlow	(	const uint8_t *	buf,
		uint32_t	len
	)

protectedvirtual

Slow path write.

Implements contrail::sandesh::transport::TBufferBase.

void contrail::sandesh::transport::TMemoryBuffer::wroteBytes ( uint32_t len )

Member Data Documentation

uint8_t* contrail::sandesh::transport::TMemoryBuffer::buffer_

protected

Definition at line 465 of file TBufferTransports.h.

uint32_t contrail::sandesh::transport::TMemoryBuffer::bufferSize_

protected

Definition at line 468 of file TBufferTransports.h.

const uint32_t contrail::sandesh::transport::TMemoryBuffer::defaultSize = 1024

static

Definition at line 222 of file TBufferTransports.h.

bool contrail::sandesh::transport::TMemoryBuffer::owner_

protected

Definition at line 471 of file TBufferTransports.h.

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

TBufferTransports.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation