libdodo: dodo::io::file::regular Class Reference

dodo::io::file::regular Class Reference

provides file I/O manipulations More...

#include <ioFileRegular.h>

Inheritance diagram for dodo::io::file::regular:
Inheritance graph
[legend]
Collaboration diagram for dodo::io::file::regular:
Collaboration graph
[legend]

List of all members.

Public Types

enum  operationEnum { OPERATION_OPEN = 128, OPERATION_CLOSE }
 

defines type of operation for xexec

More...
enum  openModeEnum { OPEN_MODE_READ_ONLY, OPEN_MODE_READ_WRITE, OPEN_MODE_READ_WRITE_TRUNCATE }
 

defines modes to open file

More...

Public Member Functions

 regular (short protection=channel::PROTECTION_PROCESS)
 constructor
 regular (const dodoString &path, short mode, short protection=channel::PROTECTION_PROCESS)
 constructor
 regular (const regular &)
 copy constructor
virtual ~regular ()
 destructor
void clone (const regular &file)
 clone file object
void open (const dodoString &path, short mode)
 open file
virtual void close ()
 close file
virtual void flush () const
 flush output
virtual void erase ()
 erase node on position

Protected Member Functions

virtual int inDescriptor () const
virtual int outDescriptor () const
virtual unsigned long _read (char *const data) const
virtual unsigned long _readString (char *const data) const
 read null- or newline- terminated string
virtual unsigned long _write (const char *const data) const
virtual unsigned long _writeString (const char *const data) const
 write null- terminated string

Detailed Description

provides file I/O manipulations

Definition at line 50 of file ioFileRegular.h.

Member Enumeration Documentation

enum dodo::io::file::regular::openModeEnum

defines modes to open file

Enumerator:
OPEN_MODE_READ_ONLY 

reading from the file

OPEN_MODE_READ_WRITE 

reading and writing[creates if not exists]

OPEN_MODE_READ_WRITE_TRUNCATE 

file will be truncated if exists

Definition at line 68 of file ioFileRegular.h.

00068                                   {
00069                     OPEN_MODE_READ_ONLY,
00070                     OPEN_MODE_READ_WRITE,
00071                     OPEN_MODE_READ_WRITE_TRUNCATE,
00072                 };

enum dodo::io::file::regular::operationEnum

defines type of operation for xexec

Enumerator:
OPERATION_OPEN 
OPERATION_CLOSE 

Reimplemented from dodo::io::channel.

Reimplemented in dodo::io::file::temp.

Definition at line 59 of file ioFileRegular.h.

00059                                    {
00060                     OPERATION_OPEN = 128,
00061                     OPERATION_CLOSE
00062                 };

Constructor & Destructor Documentation

dodo::io::file::regular::regular ( short  protection = channel::PROTECTION_PROCESS  ) 

constructor

Parameters:
protection defines type of IO protection,
See also:
io::channel::protectionEnum
dodo::io::file::regular::regular ( const dodoString &  path,
short  mode,
short  protection = channel::PROTECTION_PROCESS 
)

constructor

Parameters:
path defines path to the file
mode defines mode to open file,
See also:
file::regular::openModeEnum
Parameters:
protection defines type of IO protection,
See also:
io::channel::protectionEnum
dodo::io::file::regular::regular ( const regular &   ) 

copy constructor

Note:
xexec object is not copied
virtual dodo::io::file::regular::~regular (  )  [virtual]

destructor

Member Function Documentation

virtual unsigned long dodo::io::file::regular::_read ( char *const   data  )  const [protected, virtual]
Returns:
amount in bytes of successfully read data
Parameters:
data defines buffer that will be filled
Note:
not more then bs(including null)

Implements dodo::io::channel.

virtual unsigned long dodo::io::file::regular::_readString ( char *const   data  )  const [protected, virtual]

read null- or newline- terminated string

Returns:
amount in bytes of successfully read data
Parameters:
data defines buffer that will be filled
Note:
not more then bs(including null)

Implements dodo::io::channel.

virtual unsigned long dodo::io::file::regular::_write ( const char *const   data  )  const [protected, virtual]
Returns:
amount in bytes of successfully written data
Parameters:
data defines data that will be written

Implements dodo::io::channel.

virtual unsigned long dodo::io::file::regular::_writeString ( const char *const   data  )  const [protected, virtual]

write null- terminated string

Returns:
amount in bytes of successfully written data
Parameters:
data defines data that will be written
Note:
write only to the end of the file(append)

Implements dodo::io::channel.

void dodo::io::file::regular::clone ( const regular &  file  ) 

clone file object

Parameters:
file defines object to clone
Note:
xexec object is not copied

Reimplemented in dodo::io::file::temp.

virtual void dodo::io::file::regular::close (  )  [virtual]

close file

virtual void dodo::io::file::regular::erase (  )  [virtual]

erase node on position

virtual void dodo::io::file::regular::flush (  )  const [virtual]

flush output

Implements dodo::io::channel.

virtual int dodo::io::file::regular::inDescriptor (  )  const [protected, virtual]
Returns:
descriptor of the input stream

Implements dodo::io::event::descriptor.

void dodo::io::file::regular::open ( const dodoString &  path,
short  mode 
)

open file

Parameters:
path defines path to the file
mode defines mode to open file,
See also:
file::regular::openModeEnum
virtual int dodo::io::file::regular::outDescriptor (  )  const [protected, virtual]
Returns:
descriptor of the output stream

Implements dodo::io::event::descriptor.

The documentation for this class was generated from the following file:
Generated on Sun Nov 8 03:44:53 2009 for libdodo by  doxygen 1.6.1