AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.3.0
AMPS::MemoryStoreBuffer Class Reference

A Buffer implementation that uses memory for storage. More...

#include <MemoryStoreBuffer.hpp>

+ Inheritance diagram for AMPS::MemoryStoreBuffer:

Public Member Functions

virtual size_t getSize () const
 Get the current size of the Buffer in bytes. More...
 
virtual void setSize (size_t newSize_)
 Set the size for the buffer. More...
 
virtual size_t getPosition () const
 Get the current position in the buffer. More...
 
virtual void setPosition (size_t position_)
 Set the buffer postion to a location. More...
 
virtual void putByte (char byte_)
 Put a byte into the buffer at the current position and advance. More...
 
virtual char getByte ()
 Get the next byte from the buffer and advance. More...
 
virtual void putSizet (size_t s_)
 Put a size_t value into the buffer at the current position and advance past it. More...
 
virtual size_t getSizet ()
 Get a size_t value at the current buffer position and advance past it. More...
 
virtual void putInt32 (amps_int32_t s_)
 Put a 32-bit int value into the buffer and advance past it. More...
 
virtual amps_int32_t getInt32 ()
 Get the 32-bit int value at the current buffer position and advance past it. More...
 
virtual void putUint32 (amps_uint32_t s_)
 Put an unsigned 32-bit int value into the buffer at the current position and advance past the end of it. More...
 
virtual amps_uint32_t getUint32 ()
 Get the unsigned 32-bit int value at the current buffer position and advance past it. More...
 
virtual void putInt64 (amps_int64_t s_)
 Put an amps_int64_t value into the buffer at the current position and advance past it. More...
 
virtual amps_int64_t getInt64 ()
 Get a 64-bit int value at the current buffer position and advance past it. More...
 
virtual void putUint64 (amps_uint64_t s_)
 Put an amps_uint64_t value into the buffer at the current position and advance past it. More...
 
virtual amps_uint64_t getUint64 ()
 Get an unsigned 64-bit int value at the current buffer position and advance past it. More...
 
virtual void putBytes (const char *data_, size_t dataLength_)
 Put the given length of bytes in data into the buffer at the current position and advance past them. More...
 
virtual void putBytes (const Buffer::ByteArray &bytes_)
 Put the given bytes into the buffer at the current position and advance past them. More...
 
virtual Buffer::ByteArray getBytes (size_t numBytes_)
 Get the given number of bytes from the buffer. More...
 
virtual void copyBytes (char *buffer_, size_t numBytes_)
 Copy the given number of bytes from this buffer to the given buffer. More...
 
virtual void zero (size_t offset_, size_t length_)
 Set the given number of bytes in the buffer to zero starting at the given position. More...
 
virtual void copyBytes (size_t destination_, size_t source_, size_t number_)
 Move the given number of bytes at the given location to the new location Buffer should do this in the most optimal fashion. More...
 

Detailed Description

A Buffer implementation that uses memory for storage.

Member Function Documentation

virtual void AMPS::MemoryStoreBuffer::copyBytes ( char *  buffer_,
size_t  numBytes_ 
)
inlinevirtual

Copy the given number of bytes from this buffer to the given buffer.

Parameters
buffer_The destination for the copied bytes.
numBytes_The number of bytes to get from the buffer.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::copyBytes ( size_t  destination_,
size_t  source_,
size_t  number_ 
)
inlinevirtual

Move the given number of bytes at the given location to the new location Buffer should do this in the most optimal fashion.

Parameters
destination_The destination offset to copy the bytes to
source_The source offset in the buffer to copy from
number_The number of bytes to move

Implements AMPS::Buffer.

virtual char AMPS::MemoryStoreBuffer::getByte ( )
inlinevirtual

Get the next byte from the buffer and advance.

Returns
The byte at the current position.

Implements AMPS::Buffer.

virtual Buffer::ByteArray AMPS::MemoryStoreBuffer::getBytes ( size_t  numBytes_)
inlinevirtual

Get the given number of bytes from the buffer.

Parameters
numBytes_The number of bytes to get from the buffer.
Returns
The bytes from the buffer.

Implements AMPS::Buffer.

virtual amps_int32_t AMPS::MemoryStoreBuffer::getInt32 ( )
inlinevirtual

Get the 32-bit int value at the current buffer position and advance past it.

Returns
The 32-bit int value at the current position.

Implements AMPS::Buffer.

virtual amps_int64_t AMPS::MemoryStoreBuffer::getInt64 ( )
inlinevirtual

Get a 64-bit int value at the current buffer position and advance past it.

Returns
The amps_int64_t value.

Implements AMPS::Buffer.

virtual size_t AMPS::MemoryStoreBuffer::getPosition ( ) const
inlinevirtual

Get the current position in the buffer.

Returns
The position in the buffer.

Implements AMPS::Buffer.

virtual size_t AMPS::MemoryStoreBuffer::getSize ( ) const
inlinevirtual

Get the current size of the Buffer in bytes.

Returns
The size in bytes.

Implements AMPS::Buffer.

virtual size_t AMPS::MemoryStoreBuffer::getSizet ( )
inlinevirtual

Get a size_t value at the current buffer position and advance past it.

Returns
The size_t value.

Implements AMPS::Buffer.

virtual amps_uint32_t AMPS::MemoryStoreBuffer::getUint32 ( )
inlinevirtual

Get the unsigned 32-bit int value at the current buffer position and advance past it.

Returns
The unsigned 32-bit int value.

Implements AMPS::Buffer.

virtual amps_uint64_t AMPS::MemoryStoreBuffer::getUint64 ( )
inlinevirtual

Get an unsigned 64-bit int value at the current buffer position and advance past it.

Returns
The amps_uint64_t value.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putByte ( char  byte_)
inlinevirtual

Put a byte into the buffer at the current position and advance.

Parameters
byte_The byte to put in the buffer.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putBytes ( const char *  data_,
size_t  dataLength_ 
)
inlinevirtual

Put the given length of bytes in data into the buffer at the current position and advance past them.

Parameters
data_A pointer to the beginning of the bytes to write.
dataLength_The number of bytes from data_ to write.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putBytes ( const Buffer::ByteArray &  bytes_)
inlinevirtual

Put the given bytes into the buffer at the current position and advance past them.

Parameters
bytes_The bytes to write into the buffer.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putInt32 ( amps_int32_t  i_)
inlinevirtual

Put a 32-bit int value into the buffer and advance past it.

Parameters
i_The 32-bit int value.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putInt64 ( amps_int64_t  i_)
inlinevirtual

Put an amps_int64_t value into the buffer at the current position and advance past it.

Parameters
i_The amps_int64_t value.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putSizet ( size_t  s_)
inlinevirtual

Put a size_t value into the buffer at the current position and advance past it.

Parameters
s_The size_t value.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putUint32 ( amps_uint32_t  i_)
inlinevirtual

Put an unsigned 32-bit int value into the buffer at the current position and advance past the end of it.

Parameters
i_The unsigned 32-bit int value to write to the buffer.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::putUint64 ( amps_uint64_t  ui_)
inlinevirtual

Put an amps_uint64_t value into the buffer at the current position and advance past it.

Parameters
ui_The amps_uint64_t value.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::setPosition ( size_t  position_)
inlinevirtual

Set the buffer postion to a location.

Parameters
position_The new buffer position.

Implements AMPS::Buffer.

virtual void AMPS::MemoryStoreBuffer::setSize ( size_t  newSize_)
inlinevirtual

Set the size for the buffer.

Parameters
newSize_The new size in bytes for the buffer.

Implements AMPS::Buffer.

Reimplemented in AMPS::MMapStoreBuffer.

virtual void AMPS::MemoryStoreBuffer::zero ( size_t  offset_,
size_t  length_ 
)
inlinevirtual

Set the given number of bytes in the buffer to zero starting at the given position.

Parameters
offset_The position at which to start setting bytes to 0.
length_The number of bytes to set to zero.

Implements AMPS::Buffer.


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