A simple memory buffer with some helper functions. More...
#include <buffer.h>
Public Member Functions | |
| Buffer () | |
| Construct a new, empty buffer. | |
| Buffer (const uint64_t size) | |
| Construct a new buffer of the given size. | |
| ~Buffer () | |
| Destruct the buffer. | |
| void | clear () |
| Flush the buffer, deleting all data. | |
| T * | pack () |
| Tighten the allocated memory to the size of the buffer. | |
| Buffer (Buffer &from) | |
| Copy constructor, transfers ownership to new Buffer. | |
| const Buffer & | operator= (Buffer &from) |
| Assignment operator, copies data from Buffer. | |
| T & | operator[] (const uint64_t position) |
| Direct access to the element at the given index. | |
| const T & | operator[] (const uint64_t position) const |
| Direct const access to an element. | |
| T * | resize (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. | |
| void | grow (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. | |
| T * | reserve (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. | |
| T * | reset (const uint64_t newSize) |
| Set the buffer size and malloc enough memory. | |
| void | append (const T *data, const uint64_t size) |
| Append elements to the buffer, increasing the size. | |
| void | append (const T &element) |
| Append one element to the buffer. | |
| void | replace (const void *data, const uint64_t size) |
| Replace the existing data with new data. | |
| void | swap (Buffer &buffer) |
| Swap the buffer contents with another Buffer. | |
| T * | getData () |
| const T * | getData () const |
| bool | setSize (const uint64_t size) |
| Set the size of the buffer without changing its allocation. | |
| uint64_t | getSize () const |
| bool | isEmpty () const |
| uint64_t | getMaxSize () const |
Detailed Description
template<class T>
class lunchbox::Buffer< T >
A simple memory buffer with some helper functions.
For bigger data (>100k) using a std::vector< uint8_t > has a high overhead when resizing (>1ms). This buffer just memcpy's elements, i.e., it should only be used for PODs since the copy constructor or assignment operator is not called on the copied elements. Primarily used for binary data, e.g., in eq::Image. The implementation works like a pool, that is, data is only released when the buffer is deleted or clear() is called.
Constructor & Destructor Documentation
| lunchbox::Buffer< T >::Buffer | ( | ) | [inline] |
| lunchbox::Buffer< T >::Buffer | ( | const uint64_t | size | ) | [inline] |
Construct a new buffer of the given size.
- Version:
- 1.0
Definition at line 45 of file buffer.h.
References lunchbox::Buffer< T >::reset().
Here is the call graph for this function:
| lunchbox::Buffer< T >::~Buffer | ( | ) | [inline] |
Destruct the buffer.
- Version:
- 1.0
Definition at line 49 of file buffer.h.
References lunchbox::Buffer< T >::clear().
Here is the call graph for this function:
| lunchbox::Buffer< T >::Buffer | ( | Buffer< T > & | from | ) | [inline] |
Member Function Documentation
| void lunchbox::Buffer< T >::append | ( | const T * | data, |
| const uint64_t | size | ||
| ) | [inline] |
Append elements to the buffer, increasing the size.
- Version:
- 1.0
Definition at line 161 of file buffer.h.
References lunchbox::Buffer< T >::resize().
Here is the call graph for this function:
| void lunchbox::Buffer< T >::append | ( | const T & | element | ) | [inline] |
Append one element to the buffer.
- Version:
- 1.0
Definition at line 172 of file buffer.h.
References lunchbox::Buffer< T >::resize().
Here is the call graph for this function:
| void lunchbox::Buffer< T >::clear | ( | ) | [inline] |
Flush the buffer, deleting all data.
- Version:
- 1.0
Definition at line 52 of file buffer.h.
Referenced by lunchbox::Buffer< T >::~Buffer().
Here is the caller graph for this function:
| T* lunchbox::Buffer< T >::getData | ( | ) | [inline] |
| const T* lunchbox::Buffer< T >::getData | ( | ) | const [inline] |
| uint64_t lunchbox::Buffer< T >::getMaxSize | ( | ) | const [inline] |
| uint64_t lunchbox::Buffer< T >::getSize | ( | ) | const [inline] |
| void lunchbox::Buffer< T >::grow | ( | const uint64_t | newSize | ) | [inline] |
Ensure that the buffer contains at least newSize elements.
Existing data is retained. The size is increased, if necessary.
- Version:
- 1.0
Definition at line 120 of file buffer.h.
References lunchbox::Buffer< T >::resize().
Here is the call graph for this function:
| bool lunchbox::Buffer< T >::isEmpty | ( | ) | const [inline] |
| const Buffer& lunchbox::Buffer< T >::operator= | ( | Buffer< T > & | from | ) | [inline] |
Assignment operator, copies data from Buffer.
- Version:
- 1.0
Definition at line 79 of file buffer.h.
References lunchbox::Buffer< T >::replace().
Here is the call graph for this function:
| T& lunchbox::Buffer< T >::operator[] | ( | const uint64_t | position | ) | [inline] |
| const T& lunchbox::Buffer< T >::operator[] | ( | const uint64_t | position | ) | const [inline] |
| T* lunchbox::Buffer< T >::pack | ( | ) | [inline] |
| void lunchbox::Buffer< T >::replace | ( | const void * | data, |
| const uint64_t | size | ||
| ) | [inline] |
Replace the existing data with new data.
- Version:
- 1.0
Definition at line 179 of file buffer.h.
References lunchbox::Buffer< T >::reserve().
Referenced by lunchbox::Buffer< T >::operator=().
Here is the call graph for this function:
Here is the caller graph for this function:
| T* lunchbox::Buffer< T >::reserve | ( | const uint64_t | newSize | ) | [inline] |
Ensure that the buffer contains at least newSize elements.
Existing data may be deleted.
- Returns:
- the new pointer to the first element.
- Version:
- 1.0
Definition at line 133 of file buffer.h.
Referenced by lunchbox::Buffer< T >::replace(), and lunchbox::Buffer< T >::reset().
Here is the caller graph for this function:
| T* lunchbox::Buffer< T >::reset | ( | const uint64_t | newSize | ) | [inline] |
Set the buffer size and malloc enough memory.
Existing data may be deleted.
- Returns:
- the new pointer to the first element.
- Version:
- 1.0
Definition at line 153 of file buffer.h.
References lunchbox::Buffer< T >::reserve(), and lunchbox::Buffer< T >::setSize().
Referenced by lunchbox::Buffer< T >::Buffer().
Here is the call graph for this function:
Here is the caller graph for this function:
| T* lunchbox::Buffer< T >::resize | ( | const uint64_t | newSize | ) | [inline] |
Ensure that the buffer contains at least newSize elements.
Existing data is retained. The size is set.
- Returns:
- the new pointer to the first element.
- Version:
- 1.0
Definition at line 100 of file buffer.h.
Referenced by lunchbox::Buffer< T >::append(), and lunchbox::Buffer< T >::grow().
Here is the caller graph for this function:
| bool lunchbox::Buffer< T >::setSize | ( | const uint64_t | size | ) | [inline] |
Set the size of the buffer without changing its allocation.
This method only modifies the size parameter. If the current allocation of the buffer is too small, it asserts, returns false and does not change the size.
- Version:
- 1.0
Definition at line 219 of file buffer.h.
Referenced by lunchbox::Buffer< T >::reset().
Here is the caller graph for this function:
| void lunchbox::Buffer< T >::swap | ( | Buffer< T > & | buffer | ) | [inline] |
The documentation for this class was generated from the following file:
