Conexus::NSPR::FileDescriptor Class Reference

#include <conexus/nspr_filedescriptor.h>

Inheritance diagram for Conexus::NSPR::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 NSPR file descriptors.

Author:
Rick L Vinyard Jr


Public Types

typedef ConexusPointer< FileDescriptorpointer

Public Member Functions

 IDIOSKOPOS_OBJECT (Conexus::NSPR::FileDescriptor)
virtual PRFileDesc * 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 ssize_t input_available ()
 FileDescriptor (PRFileDesc *fd=NULL, bool close_on_destruction=true)
virtual PRFileDesc * 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 ssize_t input_available ()
virtual const std::string & object_type ()
 FileDescriptor (PRFileDesc *fd=NULL, bool close_on_destruction=true)
virtual PRFileDesc * 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 ssize_t input_available ()
virtual const std::string & object_type ()

Protected Member Functions

 FileDescriptor (PRFileDesc *fd=NULL, bool close_on_destruction=true)
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)
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

PRFileDesc * m_fd
PRFileDesc * m_fd
PRFileDesc * m_fd


Member Function Documentation

PRFileDesc * Conexus::NSPR::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

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

void Conexus::NSPR::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::NSPR::Socket, Conexus::NSPR::Socket, and Conexus::NSPR::Socket.

virtual PRFileDesc* Conexus::NSPR::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

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

virtual void Conexus::NSPR::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::NSPR::Socket, Conexus::NSPR::Socket, and Conexus::NSPR::Socket.

virtual PRFileDesc* Conexus::NSPR::FileDescriptor::fd (  )  throw () [virtual]

Base class method returning the raw file descriptor.

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

virtual void Conexus::NSPR::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::NSPR::Socket, Conexus::NSPR::Socket, and Conexus::NSPR::Socket.


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