Class that represents blob primitive type. More...

#include <SPL/Runtime/Type/Blob.h>

Public Member Functions

blob ()

blob (unsigned char const *data, uint64_t size)

blob (const List &data)

blob (const blob &ot)

~blob ()

blob & operator= (const blob &ot)

blob & operator+= (const blob &ot)

blob & operator+= (uint8 byte)

blob & operator+= (const List &bytes)

void append (unsigned char const *data, uint64_t size)

blob operator+ (const blob &ot) const

bool operator== (const blob &ot) const

bool operator!= (const blob &ot) const

bool operator< (const blob &ot) const

bool operator>= (const blob &ot) const

bool operator> (const blob &ot) const

bool operator<= (const blob &ot) const

void clear ()

unsigned char const & operator[] (uint64_t idx) const

unsigned char const & at (uint64_t idx) const

unsigned char & operator[] (uint64_t idx)

unsigned char & at (uint64_t idx)

uint64_t getSize () const

unsigned char const * getData (uint64_t &size) const

unsigned char const * getData () const

void setData (unsigned char const *data, uint64_t size)

void adoptData (unsigned char *data, uint64_t size)

unsigned char * releaseData (uint64_t &size)

void swap (blob &ot)

bool ownsData () const

void useExternalData (unsigned char *data, uint64_t size)

template<class BufferType >

void serialize (ByteBuffer< BufferType > &buf) const

template<class BufferType >

void deserialize (ByteBuffer< BufferType > &buf)

void serialize (std::ostream &ostr) const

void deserialize (std::istream &istr)

size_t hashCode () const

size_t getSerializedSize () const

Detailed Description

Class that represents blob primitive type.

Constructor & Destructor Documentation

SPL::blob::blob ( )

inline

Default constructor

SPL::blob::blob ( unsigned char const * data,

uint64_t size

)

Constructor. The data is copied from the memory block passed in as a parameter, into the internal buffer hold by the blob

Parameters:

data pointer to the memory block to be used for copying data

size size of the memory block to be used for copying data

SPL::blob::blob ( const List & data )

Constructor. The data is copied from the list passed in as a parameter, into the internal buffer hold by the blob

Parameters:

data list of bytes

SPL::blob::blob ( const blob & ot )

Copy constructor

Parameters:

ot blob to copy from

SPL::blob::~blob ( )

Destructor

Member Function Documentation

blob& SPL::blob::operator= ( const blob & ot )

Assignment operator

Parameters:

ot blob to assign from

Returns:: self

blob& SPL::blob::operator+= ( const blob & ot )

Concatenation operator

Parameters:

ot blob to assign from

Returns:: self (with appended contents)

blob& SPL::blob::operator+= ( uint8 byte )

Concatenation operator

Parameters:

byte byte to be appended

Returns:: self (with appended contents)

blob& SPL::blob::operator+= ( const List & bytes )

Concatenation operator

Parameters:

bytes list of bytes to be appended

Returns:: self (with appended contents)

void SPL::blob::append ( unsigned char const * data,

uint64_t size

)

Append to a blob

Parameters:

data bytes to be appended

size number of bytes to be appended

blob SPL::blob::operator+ ( const blob & ot ) const

Concatenation operator

Parameters:

ot blob to concatenate to

Returns:: blob containing concatenation of *this and ot

bool SPL::blob::operator== ( const blob & ot ) const

Equality comparison operator

Parameters:

ot blob to compare with

Returns:: true if equal, false otherwise

bool SPL::blob::operator!= ( const blob & ot ) const

inline

Non-equality comparison operator

Parameters:

ot blob to compare with

Returns:: true if not equal, false otherwise

bool SPL::blob::operator< ( const blob & ot ) const

Less than comparison operator

Parameters:

ot blob to compare with

Returns:: true if less than, false otherwise

bool SPL::blob::operator>= ( const blob & ot ) const

inline

Greater than or equal comparison operator

Parameters:

ot blob to compare with

Returns:: true if greater than or equal, false otherwise

bool SPL::blob::operator> ( const blob & ot ) const

Greater than comparison operator

Parameters:

ot blob to compare with

Returns:: true if greater than, false otherwise

bool SPL::blob::operator<= ( const blob & ot ) const

inline

Less than or equal comparison operator

Parameters:

ot blob to compare with

Returns:: true if less than or equal, false otherwise

void SPL::blob::clear ( )

inline

Clear the data

unsigned char const& SPL::blob::operator[] ( uint64_t idx ) const

Element access (read-only)

Parameters:

idx element index

Returns:: byte at index idx

unsigned char const& SPL::blob::at ( uint64_t idx ) const

inline

Element access (read-only)

Parameters:

idx element index

Returns:: byte at index idx

unsigned char& SPL::blob::operator[] ( uint64_t idx )

Element access (read-write)

Parameters:

idx element index

Returns:: byte at index idx

unsigned char& SPL::blob::at ( uint64_t idx )

inline

Element access (read-write)

Parameters:

idx element index

Returns:: byte at index idx

uint64_t SPL::blob::getSize ( ) const

inline

Get the size of the blob

Returns:: size of the blob

unsigned char const* SPL::blob::getData ( uint64_t & size ) const

inline

Get a pointer to the data of the blob. The management of the returned memory block still belongs to the blob object.

Parameters:

size this is an out-param used to return the size of the blob's data

Returns:: pointer to the data of the blob

unsigned char const* SPL::blob::getData ( ) const

inline

Get a pointer to the data of the blob. The management of the returned memory block still belongs to the blob object.

Returns:: pointer to the data of the blob

void SPL::blob::setData ( unsigned char const * data,

uint64_t size

)

Set the data of the blob. The data is copied from the memory block passed in as a parameter, into the internal buffer hold by the blob. The blob owns the copied in memory.

Parameters:

data pointer to the memory block to be used for copying data

size size of the memory block to be used for copying data

void SPL::blob::adoptData ( unsigned char * data,

uint64_t size

)

Set the data of the blob by taking over the management of the memory block passed in as a parameter. No copies are performed.

Parameters:

data pointer to the memory block to be adopted

size size of the memory block to be adopted

unsigned char* SPL::blob::releaseData ( uint64_t & size )

Get a pointer to the data of the blob, and at the same time disassociate the blob from its data. The management of the returned memory block now does not belong to this blob anymore.

Precondition:: ownsData() == true;

Parameters:

size this is an in-param used to return the size of the blob's data

Returns:: pointer to the data of the blob

Exceptions:

SPLRuntimeBlobNotOwnedException if !ownsData()

void SPL::blob::swap ( blob & ot )

Swap with another blob

Parameters:

ot the blob to swap with

bool SPL::blob::ownsData ( ) const

inline

Does this blob own the data, or it is holding memory owned by someone else?

Returns:: true if the blob owns the data

void SPL::blob::useExternalData ( unsigned char * data,

uint64_t size

)

inline

Use external data in the blob. No copies will be done. This memory will NOT be freed when the blob is destroyed. It is the responsibility of the developer to ensure that the memory remains allocated for the duration of the blob object.

Parameters:

data pointer to the memory block to be used

size size of the memory block to be used

template<class BufferType >

void SPL::blob::serialize ( ByteBuffer< BufferType > & buf ) const

inline

Serialize (binary)

Parameters:

buf byte buffer to use

template<class BufferType >

void SPL::blob::deserialize ( ByteBuffer< BufferType > & buf )

inline

Deserialize (binary)

Parameters:

buf byte buffer to use

void SPL::blob::serialize ( std::ostream & ostr ) const

Serialize (character)

Parameters:

ostr output stream

void SPL::blob::deserialize ( std::istream & istr )

Deserialize (character)

Parameters:

istr input stream

size_t SPL::blob::hashCode ( ) const

Get hash code

Returns:: hash code

size_t SPL::blob::getSerializedSize ( ) const

inline

Get the size in bytes when serialized

Returns:: size in bytes when serialized

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

SPL/Runtime/Type/Blob.h