scopira::tool::bufferflow Class Reference
#include <bufferflow.h>
Inheritance diagram for scopira::tool::bufferflow:
Public Types | |
| typedef std::vector< tool::flow_i::byte_t > | byte_buffer_t |
 Public Types inherited from scopira::tool::flow_i | |
| enum | { input_c = 1, output_c = 2 } |
| typedef scopira::tool::byte_t | byte_t |
| typedef int | mode_t |
Public Member Functions | |
| bufferflow (void) | |
| default constructor | |
| virtual | ~bufferflow (void) |
| destructor | |
| virtual bool | failed (void) const |
| are we in a failed state? | |
| virtual size_t | read (byte_t *buf, size_t maxsize) |
| read raw block data, returns num read in | |
| virtual size_t | write (const byte_t *buf, size_t size) |
| write a raw block of data | |
| byte_t * | c_array (void) |
| returns the buffer as a raw c array More... | |
| const byte_t * | c_array (void) const |
| returns the buffer as a raw c array | |
| size_t | size (void) const |
| return the size of the internal buffer | |
| size_t | capacity (void) const |
| void | reset (void) |
| resets the buffer index | |
| void | reserve (size_t _size) |
| reserve an internal buffer | |
| void | reset_resize (size_t _size) |
| resizes the internal buffer. this also resets the index pointer | |
| Public Member Functions inherited from scopira::tool::iflow_i | |
| virtual size_t | read_byte (byte_t &out) |
| template<class TT > | |
| size_t | read_array (TT *_buf, size_t _numelem) |
| size_t | read_void (void *_buf, size_t _maxsize) |
| Public Member Functions inherited from scopira::tool::object | |
| virtual | ~object () |
| int | add_ref (void) const |
| bool | sub_ref (void) const |
| void | auto_ref (void) const |
| int | current_ref (void) const |
| virtual scopira::tool::oflow_i & | print (scopira::tool::oflow_i &o) const |
| virtual bool | load (scopira::tool::iobjflow_i &in) |
| virtual void | save (scopira::tool::oobjflow_i &out) const |
| bool | is_alive_object (void) const |
| bool | is_dead_object (void) const |
| Public Member Functions inherited from scopira::tool::oflow_i | |
| virtual size_t | write_byte (byte_t b) |
| template<class TT > | |
| size_t | write_array (const TT *_buf, size_t _numelem) |
| size_t | write_void (const void *_buf, size_t _size) |
Additional Inherited Members | |
| Protected Member Functions inherited from scopira::tool::object | |
| object (void) | |
| object (bool neverusecounter) | |
Detailed Description
A flow that reads and writes to an internal byte buffer (ie to memory).
Member Function Documentation
◆ c_array()
|
inline |
returns the buffer as a raw c array
returns a pointer to the internal buffer is this legal? -ademko
References size().
◆ capacity()
|
inline |
returns the capacity of the internal buffer. this is related to reserve, see std::vector for information
References reserve(), reset(), and reset_resize().
The documentation for this class was generated from the following file:
