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

This class encapsulates a POSIX pipe. More...

#include <pipe.h>

Inheritance diagram for Conexus::Pipe:

[legend]

List of all members.

Public Types
typedef ConexusPointer< Pipe >	pointer
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

Reimplemented from Conexus::FileDescriptor.

Examples:

anonymous_pipe.cpp, and anonymous_pipe_server.cpp.

---

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]

Reimplemented from Conexus::FileDescriptor.

References Conexus::PIPE_READ, Conexus::PIPE_WRITE, and Conexus::throw_close_exception().

void Conexus::Pipe::close_read

(

bool

force = false

)

throw ( close_exception ) [virtual]

References Conexus::PIPE_READ, and Conexus::throw_close_exception().

void Conexus::Pipe::close_write

(

bool

force = false

)

throw ( close_exception ) [virtual]

References Conexus::PIPE_WRITE, and Conexus::throw_close_exception().

Conexus::Pipe::CONEXUS_ENDPOINT_GENERIC_CREATE

(

)

Pipe::pointer Conexus::Pipe::create

(

)

[static]

Examples:

anonymous_pipe.cpp, and anonymous_pipe_server.cpp.

References Pipe().

size_t Conexus::Pipe::input_available

(

)

throw () [virtual]

Reimplemented from Conexus::Endpoint.

void Conexus::Pipe::open

(

)

throw ( open_exception ) [virtual]

Implements Conexus::Endpoint.

References Conexus::FileDescriptor::m_fd, Conexus::Endpoint::m_state, m_write_fd, Conexus::PIPE_READ, Conexus::PIPE_WRITE, and Conexus::Endpoint::set_state_opened().

Data Conexus::Pipe::read_data	(	size_t	size,
		Timeout	timeout
	)			throw ( read_exception ) [protected, virtual]

Reimplements Endpoint::read_data() using FileDescriptor::read_data().

Changes from FileDescriptor::read_data()

• If read size is zero, throws Conexus::exception::read::disconnected

Reimplemented from Conexus::FileDescriptor.

References Conexus::FileDescriptor::read_data().

size_t Conexus::Pipe::write_data	(	const Data	data,
		Timeout	timeout
	)			throw ( write_exception ) [protected, virtual]

Reimplemented from Conexus::FileDescriptor.

References Conexus::throw_write_exception().

---

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:

• pipe.h
• enums.h
• pipe.cpp