CS::DataBuffer< Allocator > Class Template Reference
This is an implementation of iDataBuffer interface. More...
#include <csutil/databuf.h>
Inherits scfImplementation1<DataBuffer<Allocator>, iDataBuffer>.
Public Member Functions | |
| DataBuffer (iDataBuffer *source, bool appendNull=true) | |
| Duplicate an existing data buffer. Also appends a 0 char. | |
| DataBuffer (char *iData, size_t iSize, bool should_delete, const Allocator &alloc) | |
| Construct an data buffer object given a existing pointer. | |
| DataBuffer (char *iData, size_t iSize, bool should_delete=true) | |
| Construct an data buffer object given a existing pointer. | |
| DataBuffer (size_t iSize, const Allocator &alloc) | |
| Construct an preallocated data buffer (filled with garbage initially). | |
| DataBuffer (size_t iSize) | |
| Construct an preallocated data buffer (filled with garbage initially). | |
| virtual char * | GetData () const |
| Get the buffer as an abstract pointer. | |
| bool | GetDeleteOnDestruct () const |
| Return true if this databuffer will destroy its memory on destruction. | |
| virtual size_t | GetSize () const |
| Query the buffer size. | |
| virtual | ~DataBuffer () |
| Destroy (free) the buffer. | |
Detailed Description
template<class Allocator = Memory::AllocatorMalloc>
class CS::DataBuffer< Allocator >
This is an implementation of iDataBuffer interface.
The object is extremely lightweight and is recommended for use in plugins as a mean to transparently exchange abstract data between plugins.
Definition at line 41 of file databuf.h.
Constructor & Destructor Documentation
template<class Allocator = Memory::AllocatorMalloc>
| CS::DataBuffer< Allocator >::DataBuffer | ( | size_t | iSize | ) | [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| CS::DataBuffer< Allocator >::DataBuffer | ( | size_t | iSize, | |
| const Allocator & | alloc | |||
| ) | [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| CS::DataBuffer< Allocator >::DataBuffer | ( | char * | iData, | |
| size_t | iSize, | |||
| bool | should_delete = true | |||
| ) | [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| CS::DataBuffer< Allocator >::DataBuffer | ( | char * | iData, | |
| size_t | iSize, | |||
| bool | should_delete, | |||
| const Allocator & | alloc | |||
| ) | [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| CS::DataBuffer< Allocator >::DataBuffer | ( | iDataBuffer< Allocator > * | source, | |
| bool | appendNull = true | |||
| ) | [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| virtual CS::DataBuffer< Allocator >::~DataBuffer | ( | ) | [inline, virtual] |
Member Function Documentation
template<class Allocator = Memory::AllocatorMalloc>
| virtual char* CS::DataBuffer< Allocator >::GetData | ( | ) | const [inline, virtual] |
template<class Allocator = Memory::AllocatorMalloc>
| bool CS::DataBuffer< Allocator >::GetDeleteOnDestruct | ( | ) | const [inline] |
template<class Allocator = Memory::AllocatorMalloc>
| virtual size_t CS::DataBuffer< Allocator >::GetSize | ( | ) | const [inline, virtual] |
The documentation for this class was generated from the following file:
- csutil/databuf.h
Generated for Crystal Space 1.4.0 by doxygen 1.5.8
