This class represents a stream of bytes that contains (or will contain) serialized data. This class is used by the serializers to serialize or deserialize using their representation.
More...
#include <FastBuffer.h>
|
| iterator | begin () |
| | This function returns a iterator that points to the begining of the stream. More...
|
| |
| iterator | end () |
| | This function returns a iterator that points to the end of the stream. More...
|
| |
| | FastBuffer () |
| | This constructor creates an internal stream and assigns it to the eprosima::fastcdr::FastBuffers object. The user can obtain this internal stream using the function eprosima::fastcdr::FastBuffers::getBuffer(). Be careful because this internal stream is deleted in the destruction of the eprosima::fastcdr::FastBuffers object. More...
|
| |
| | FastBuffer (char *const buffer, const size_t bufferSize) |
| | This constructor assigns the user's stream of bytes to the eprosima::fastcdr::FastBuffers object. The user's stream will be used to serialize. More...
|
| |
| | FastBuffer (FastBuffer &&fbuffer) |
| | Move constructor. More...
|
| |
| char * | getBuffer () const |
| | This function returns the stream that the eprosima::fastcdr::FastBuffers uses to serialize data. More...
|
| |
| size_t | getBufferSize () const |
| | This function returns the size of the allocated memory of the stream that the eprosima::fastcdr::FastBuffers uses to serialize data. More...
|
| |
| FastBuffer & | operator= (FastBuffer &&fbuffer) |
| | Move assignment. More...
|
| |
| bool | reserve (size_t size) |
| | This function reserves memory for the internal raw buffer. It will only do so if the buffer is not yet allocated and is not externally set. More...
|
| |
| bool | resize (size_t minSizeInc) |
| | This function resizes the raw buffer. It will call the user's defined function for this purpose. More...
|
| |
| virtual | ~FastBuffer () |
| | Default destructor. More...
|
| |
This class represents a stream of bytes that contains (or will contain) serialized data. This class is used by the serializers to serialize or deserialize using their representation.
Definition at line 228 of file FastBuffer.h.
◆ iterator
◆ FastBuffer() [1/4]
| FastBuffer::FastBuffer |
( |
| ) |
|
This constructor creates an internal stream and assigns it to the eprosima::fastcdr::FastBuffers object. The user can obtain this internal stream using the function eprosima::fastcdr::FastBuffers::getBuffer(). Be careful because this internal stream is deleted in the destruction of the eprosima::fastcdr::FastBuffers object.
Definition at line 27 of file FastBuffer.cpp.
◆ FastBuffer() [2/4]
| FastBuffer::FastBuffer |
( |
char *const |
buffer, |
|
|
const size_t |
bufferSize |
|
) |
| |
This constructor assigns the user's stream of bytes to the eprosima::fastcdr::FastBuffers object. The user's stream will be used to serialize.
- Parameters
-
| buffer | The user's buffer that will be used. This buffer is not deallocated in the object's destruction. Cannot be NULL. |
| bufferSize | The length of user's buffer. |
Definition at line 34 of file FastBuffer.cpp.
◆ FastBuffer() [3/4]
| eprosima::fastcdr::FastBuffer::FastBuffer |
( |
FastBuffer && |
fbuffer | ) |
|
|
inline |
◆ ~FastBuffer()
| FastBuffer::~FastBuffer |
( |
| ) |
|
|
virtual |
◆ FastBuffer() [4/4]
| eprosima::fastcdr::FastBuffer::FastBuffer |
( |
const FastBuffer & |
| ) |
|
|
privatedelete |
◆ begin()
| iterator eprosima::fastcdr::FastBuffer::begin |
( |
| ) |
|
|
inline |
This function returns a iterator that points to the begining of the stream.
- Returns
- The new iterator.
Definition at line 302 of file FastBuffer.h.
◆ end()
| iterator eprosima::fastcdr::FastBuffer::end |
( |
| ) |
|
|
inline |
This function returns a iterator that points to the end of the stream.
- Returns
- The new iterator.
Definition at line 312 of file FastBuffer.h.
◆ getBuffer()
| char* eprosima::fastcdr::FastBuffer::getBuffer |
( |
| ) |
const |
|
inline |
This function returns the stream that the eprosima::fastcdr::FastBuffers uses to serialize data.
- Returns
- The stream used by eprosima::fastcdr::FastBuffers to serialize data.
Definition at line 283 of file FastBuffer.h.
◆ getBufferSize()
| size_t eprosima::fastcdr::FastBuffer::getBufferSize |
( |
| ) |
const |
|
inline |
This function returns the size of the allocated memory of the stream that the eprosima::fastcdr::FastBuffers uses to serialize data.
- Returns
- The size of the allocated memory of the stream used by the eprosima::fastcdr::FastBuffers to serialize data.
Definition at line 292 of file FastBuffer.h.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ reserve()
| bool FastBuffer::reserve |
( |
size_t |
size | ) |
|
This function reserves memory for the internal raw buffer. It will only do so if the buffer is not yet allocated and is not externally set.
- Parameters
-
| size | The size of the memory to be allocated. |
- Returns
- True if the allocation suceeded. False if the raw buffer was set externally or is already allocated.
Definition at line 51 of file FastBuffer.cpp.
◆ resize()
| bool FastBuffer::resize |
( |
size_t |
minSizeInc | ) |
|
This function resizes the raw buffer. It will call the user's defined function for this purpose.
- Parameters
-
| minSizeInc | The minimun growth expected of the current raw buffer. |
- Returns
- True if the operation works. False if it does not.
Definition at line 66 of file FastBuffer.cpp.
◆ m_buffer
| char* eprosima::fastcdr::FastBuffer::m_buffer |
|
private |
Pointer to the stream of bytes that contains the serialized data.
Definition at line 342 of file FastBuffer.h.
◆ m_bufferSize
| size_t eprosima::fastcdr::FastBuffer::m_bufferSize |
|
private |
The total size of the user's buffer.
Definition at line 345 of file FastBuffer.h.
◆ m_internalBuffer
| bool eprosima::fastcdr::FastBuffer::m_internalBuffer |
|
private |
This variable indicates if the managed buffer is internal or is from the user.
Definition at line 348 of file FastBuffer.h.
The documentation for this class was generated from the following files: