Conexus::FileDescriptor Class Reference

#include <conexus/filedescriptor.h>

Inheritance diagram for Conexus::FileDescriptor:

Inheritance graph
[legend]
List of all members.

Detailed Description

This class is the top level object for all subclasses performing I/O (Input/Output) operations via file descriptors (which in Linux/Unix/POSIX can be used for almost all I/O).

Author:
Rick L Vinyard Jr


Public Types

typedef ConexusPointer< FileDescriptorpointer

Public Member Functions

virtual int fd () throw ()
 Base class method returning the raw file descriptor.
virtual void close (bool force=false) throw ( close_exception )
 Closes the Endpoint object by closing the member file descriptor.
 FileDescriptor (int fd=-1, bool close_on_destruction=true)
virtual int fd () throw ()
 Base class method returning the raw file descriptor.
virtual void close (bool force=false) throw (close_exception)
 Closes the Endpoint object by closing the member file descriptor.
virtual const std::string & object_type ()
 FileDescriptor (int fd=-1, bool close_on_destruction=true)
virtual int fd () throw ()
 Base class method returning the raw file descriptor.
virtual void close (bool force=false) throw (close_exception)
 Closes the Endpoint object by closing the member file descriptor.
virtual const std::string & object_type ()

Protected Member Functions

 FileDescriptor (int fd=-1, bool close_on_destruction=true)
virtual ssize_t write_data (long int timeout, const Data data) throw ( write_exception )
virtual Data read_data (long int timeout, size_t s=0) throw ( read_exception )
virtual ssize_t write_data (long int timeout, Data::const_pointer data) throw (write_exception)
virtual Data::pointer read_data (long int timeout, size_t s=0) throw (read_exception)
virtual ssize_t write_data (long int timeout, Data::const_pointer data) throw (write_exception)
virtual Data::pointer read_data (long int timeout, size_t s=0) throw (read_exception)

Protected Attributes

int m_fd


Member Function Documentation

int Conexus::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

This class is also available as the "fd" property.

void Conexus::FileDescriptor::close ( bool  force = false  )  throw ( close_exception ) [virtual]

Closes the Endpoint object by closing the member file descriptor.

If the object is already closed will return without attempting to close.

Implements Conexus::Endpoint.

Reimplemented in Conexus::Socket, Conexus::TTY, Conexus::Socket, Conexus::TTY, Conexus::Socket, and Conexus::TTY.

virtual int Conexus::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

This class is also available as the "fd" property.

virtual void Conexus::FileDescriptor::close ( bool  force = false  )  throw (close_exception) [virtual]

Closes the Endpoint object by closing the member file descriptor.

If the object is already closed will return without attempting to close.

Implements Conexus::Endpoint.

Reimplemented in Conexus::Socket, Conexus::TTY, Conexus::Socket, Conexus::TTY, Conexus::Socket, and Conexus::TTY.

virtual int Conexus::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

This class is also available as the "fd" property.

virtual void Conexus::FileDescriptor::close ( bool  force = false  )  throw (close_exception) [virtual]

Closes the Endpoint object by closing the member file descriptor.

If the object is already closed will return without attempting to close.

Implements Conexus::Endpoint.

Reimplemented in Conexus::Socket, Conexus::TTY, Conexus::Socket, Conexus::TTY, Conexus::Socket, and Conexus::TTY.


The documentation for this class was generated from the following files:
Generated on Tue Mar 13 19:54:59 2007 by  doxygen 1.5.1