YAMI4 - C++ general-purpose interface
yami::raw_buffer_data_source Class Reference

Serializable wrapper for the raw binary data. More...

#include <raw_buffer_data_source.h>

Inherits yami::serializable.

List of all members.

Public Member Functions

 raw_buffer_data_source (const char **buffers, const std::size_t *buffer_sizes, std::size_t num_of_buffers)
 Constructor.
 raw_buffer_data_source (const char *buffer, std::size_t buffer_size)
 Constructor.
 raw_buffer_data_source (const std::vector< char > &buffer)
 Constructor.
virtual std::size_t serialize_buffer_size () const
 Returns the total size of serialization buffer.
virtual void serialize (char **buffers, std::size_t *buffer_sizes, std::size_t num_of_buffers) const
 Serializes current content into given buffer(s).
virtual const core::serializable & get_core_object () const
 Provides access to the underlying core object.

Detailed Description

Serializable wrapper for the raw binary data allows to use already serialized content for message sending. The two major use cases for this class are efficient message forwarding (when the message is received and its content is used for another message) and support for custom data models and serializers.


Constructor & Destructor Documentation

raw_buffer_data_source::raw_buffer_data_source ( const char **  buffers,
const std::size_t *  buffer_sizes,
std::size_t  num_of_buffers 
)

Constructs the buffer wrapper for the given set of buffers. The data buffer does not have to be contiguous and any number of buffer segments is allowed, provided that the size of each buffer segment is a multiple of 4 (32 bits).
The wrapper gathers the binary data from subsequent buffers as they are serialized - serialization of the wrapper copies the data from source set of buffers to the target set, which is possibly structured in a different way.
The buffers are provided as array of buffer pointers and their sizes.

Parameters:
buffersPointer to the array of buffer pointers (each of type const char *).
buffer_sizesPointer to the array of buffer sizes.
num_of_buffersNumber of buffers described by the array.
raw_buffer_data_source::raw_buffer_data_source ( const char *  buffer,
std::size_t  buffer_size 
)

Constructs the buffer wrapper for the single contiguous source buffer.

Parameters:
bufferPointer to the source buffer.
buffer_sizeSource buffer size.
raw_buffer_data_source::raw_buffer_data_source ( const std::vector< char > &  buffer)

Constructs the buffer wrapper for the single contiguous source buffer, which is given as a vector<char>.

Parameters:
bufferSource buffer.

Member Function Documentation

std::size_t raw_buffer_data_source::serialize_buffer_size ( ) const [virtual]

Computes the total size of serialization buffer(s) for the current content of this object.

Implements yami::serializable.

void raw_buffer_data_source::serialize ( char **  buffers,
std::size_t *  buffer_sizes,
std::size_t  num_of_buffers 
) const [virtual]

Serializes the current content of this object into the given buffer(s). The serialization buffer does not have to be contiguous and any number of buffer segments is allowed, provided that the size of each buffer segment is a multiple of 4 (32 bits).
The function scatters the serialized data into subsequent buffers as they become filled.
The buffers are provided as array of buffer pointers and their sizes.

Parameters:
buffersPointer to the array of buffer pointers (each of type char *).
buffer_sizesPointer to the array of buffer sizes.
num_of_buffersNumber of buffers described by the array.

Implements yami::serializable.