Scopira  20080306
scopira::tool::oflow_i Class Referenceabstract

#include <flow.h>

Inheritance diagram for scopira::tool::oflow_i:
scopira::tool::flow_i scopira::tool::object scopira::tool::bufferflow scopira::tool::bufferoflow scopira::tool::cacheoflow scopira::tool::countoflow scopira::tool::distoflow scopira::tool::fileflow scopira::tool::hashoflow scopira::tool::hexoflow scopira::tool::netflow scopira::tool::nullflow scopira::tool::otflow_i scopira::tool::stringflow scopira::tool::stringoflow scopira::tool::teeoflow scopira::tool::unixflow

Public Member Functions

virtual size_t write (const byte_t *_buf, size_t _size)=0
 
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)
 
- Public Member Functions inherited from scopira::tool::flow_i
virtual bool failed (void) const =0
 
- 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_iprint (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
 

Additional Inherited Members

- 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
 
- Protected Member Functions inherited from scopira::tool::object
 object (void)
 
 object (bool neverusecounter)
 

Detailed Description

A raw output stream of bytes

Author
Aleksander Demko

Member Function Documentation

◆ write()

◆ write_array()

template<class TT >
size_t scopira::tool::oflow_i::write_array ( const TT *  _buf,
size_t  _numelem 
)
inline

Nice wrapper around the raw write() method. Lets you write raw arrays of a particular type. POD types only. Returns the number of elelments actually written.

Author
Aleksander Demko

Referenced by scopira::basekit::narray< scopira::tool::uuid >::save(), scopira::basekit::nslice< T, DIM >::save(), and scopira::basekit::const_nslice< T, DIM >::save().

◆ write_byte()

virtual size_t scopira::tool::oflow_i::write_byte ( byte_t  b)
inlinevirtual

Writes one byte

Parameters
bthe byte to write
Returns
1 if the byte was written to the flow, 0 if not
Author
Aleksander Demko

Reimplemented in scopira::tool::cacheoflow, and scopira::tool::hexoflow.

◆ write_void()

size_t scopira::tool::oflow_i::write_void ( const void *  _buf,
size_t  _size 
)
inline

Writes a block of bytes, using a void*

Parameters
_bufthe bytes
_sizethe size of the above buffer
Returns
the number of bytes actually written
Author
Aleksander Demko

The documentation for this class was generated from the following file: