libdodo: dodo::io::block::channel Class Reference

dodo::io::block::channel Class Reference

implements an interface for I/O operations on block sources More...

#include <ioBlockChannel.h>

Inheritance diagram for dodo::io::block::channel:
Collaboration diagram for dodo::io::block::channel:

List of all members.

Public Member Functions

 channel (short protection)
 constructor
virtual ~channel ()
 destructor
virtual dodoString read () const
virtual unsigned long write (const dodoString &data) const
virtual dodoString readString () const
 read null- or newline- terminated string
virtual unsigned long writeString (const dodoString &data) const
 write null- terminated string

Public Attributes

unsigned long pos
 read/write/erase position; incremented on read/write/erase[0 by default]
bool append
 append to the end[false by default]

Detailed Description

implements an interface for I/O operations on block sources

Definition at line 45 of file ioBlockChannel.h.


Constructor & Destructor Documentation

dodo::io::block::channel::channel ( short  protection  ) 

constructor

Parameters:
protection defines type of IO protection,
See also:
io::channel::protectionEnum

Reimplemented from dodo::io::channel.

virtual dodo::io::block::channel::~channel (  )  [virtual]

destructor

Reimplemented from dodo::io::channel.


Member Function Documentation

virtual dodoString dodo::io::block::channel::read (  )  const [virtual]
Returns:
read data
Note:
not more then bs

Implements dodo::io::channel.

virtual dodoString dodo::io::block::channel::readString (  )  const [virtual]

read null- or newline- terminated string

Returns:
read data
Note:
not more then bs

Implements dodo::io::channel.

virtual unsigned long dodo::io::block::channel::write ( const dodoString &  data  )  const [virtual]
Returns:
amount in bytes of successfully written data
Parameters:
data defines data that will be written
Note:
not more then bs

Implements dodo::io::channel.

virtual unsigned long dodo::io::block::channel::writeString ( const dodoString &  data  )  const [virtual]

write null- terminated string

Returns:
amount in bytes of successfully written data
Parameters:
data defines data that will be written
Note:
not more then bs

Implements dodo::io::channel.


Member Data Documentation

append to the end[false by default]

Definition at line 89 of file ioBlockChannel.h.

unsigned long dodo::io::block::channel::pos [mutable]

read/write/erase position; incremented on read/write/erase[0 by default]

Definition at line 87 of file ioBlockChannel.h.


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

Generated on Sun Nov 8 03:44:52 2009 for libdodo by  doxygen 1.6.1