conexus logo

Conexus::Pipe Class Reference
[Conexus I/O Endpoints]

This class encapsulates a POSIX pipe. More...

#include <pipe.h>

Inheritance diagram for Conexus::Pipe:
Inheritance graph
[legend]

List of all members.

Public Types

typedef ConexusPointer< Pipepointer

Public Member Functions

 CONEXUS_ENDPOINT_GENERIC_CREATE ()
virtual ~Pipe ()
virtual void open () throw ( open_exception )
virtual void close (bool force=false) throw ( close_exception )
virtual void close_read (bool force=false) throw ( close_exception )
virtual void close_write (bool force=false) throw ( close_exception )
virtual size_t input_available () throw ()

Static Public Member Functions

static Pipe::pointer create ()

Protected Member Functions

 Pipe ()
virtual size_t write_data (const Data data, Timeout timeout) throw ( write_exception )
virtual Data read_data (size_t size, Timeout timeout) throw ( read_exception )
 Reimplements Endpoint::read_data() using FileDescriptor::read_data().

Protected Attributes

int m_write_fd

Related Functions

(Note that these are not member functions.)



enum  PipeMode { PIPE_READ = ENDPOINT_LAST_STATE<<1, PIPE_WRITE = ENDPOINT_LAST_STATE<<2 }

Detailed Description

This class encapsulates a POSIX pipe.

Author:
Rick L Vinyard Jr

Member Typedef Documentation

typedef ConexusPointer<Pipe> Conexus::Pipe::pointer

Constructor & Destructor Documentation

Conexus::Pipe::Pipe (  )  [protected]

Referenced by create().

Conexus::Pipe::~Pipe (  )  [virtual]

Member Function Documentation

void Conexus::Pipe::close ( bool  force = false  )  throw ( close_exception ) [virtual]
void Conexus::Pipe::close_read ( bool  force = false  )  throw ( close_exception ) [virtual]
void Conexus::Pipe::close_write ( bool  force = false  )  throw ( close_exception ) [virtual]
Conexus::Pipe::CONEXUS_ENDPOINT_GENERIC_CREATE (  ) 
Pipe::pointer Conexus::Pipe::create (  )  [static]
size_t Conexus::Pipe::input_available (  )  throw () [virtual]

Reimplemented from Conexus::Endpoint.

void Conexus::Pipe::open (  )  throw ( open_exception ) [virtual]
Data Conexus::Pipe::read_data ( size_t  size,
Timeout  timeout 
) throw ( read_exception ) [protected, virtual]
size_t Conexus::Pipe::write_data ( const Data  data,
Timeout  timeout 
) throw ( write_exception ) [protected, virtual]

Friends And Related Function Documentation

enum PipeMode [related]
Enumerator:
PIPE_READ 

opened for reading

PIPE_WRITE 

opened for writing


Member Data Documentation

int Conexus::Pipe::m_write_fd [protected]

Referenced by open().


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

Generated on Mon Mar 8 15:35:48 2010 for conexus by doxygen 1.6.1