Defines the method that transfer data on a UPIPE. More...

#include <UPIPE_Stream.h>

Inheritance diagram for ACE_UPIPE_Stream:

Collaboration diagram for ACE_UPIPE_Stream:

Public Types
typedef ACE_Stream< ACE_SYNCH >	MT_Stream

typedef ACE_UPIPE_Addr	PEER_ADDR

Public Member Functions
	ACE_UPIPE_Stream (void)

virtual	~ACE_UPIPE_Stream (void)

int	close (void)
	Shut down the UPIPE and release resources. More...

ACE_HANDLE	get_handle (void) const
	Return the underlying I/O handle. More...

int	send (ACE_Message_Block mb_p, ACE_Time_Value timeout=0)

int	recv (ACE_Message_Block &mb_p, ACE_Time_Value timeout=0)

ssize_t	send (const char buffer, size_t n, ACE_Time_Value timeout=0)

ssize_t	recv (char buffer, size_t n, ACE_Time_Value timeout=0)

ssize_t	send_n (const char buffer, size_t n, ACE_Time_Value timeout=0)

ssize_t	recv_n (char buffer, size_t n, ACE_Time_Value timeout=0)

int	control (int cmd, void *val) const
	Perform control operations on the UPIPE_Stream. More...

int	get_remote_addr (ACE_UPIPE_Addr &remote_sap) const
	Return the remote address we are connected to. More...

void	dump (void) const
	Dump the state of an object. More...

Public Member Functions inherited from ACE_SPIPE
int	close (void)
	Close down the SPIPE without removing the rendezvous point. More...

int	remove (void)

int	get_local_addr (ACE_SPIPE_Addr &) const
	Return the local address of this endpoint. More...

int	disable (int signum) const

void	dump (void) const
	Dump the state of an object. More...

Public Member Functions inherited from ACE_IPC_SAP
int	control (int cmd, void *) const
	Interface for <ioctl>. More...

int	enable (int value) const

int	disable (int value) const

ACE_HANDLE	get_handle (void) const
	Get the underlying handle. More...

void	set_handle (ACE_HANDLE handle)
	Set the underlying handle. More...

void	dump (void) const
	Dump the state of an object. More...

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Public Attributes inherited from ACE_SPIPE
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Public Attributes inherited from ACE_IPC_SAP
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Private Attributes
ACE_Message_Block *	mb_last_

ACE_UPIPE_Addr	remote_addr_
	Address of who we are connected to. More...

MT_Stream	stream_

int	reference_count_
	Keep track of whether the sender and receiver have both shutdown. More...

Friends
class	ACE_UPIPE_Acceptor

class	ACE_UPIPE_Connector

Additional Inherited Members
Protected Member Functions inherited from ACE_SPIPE
	ACE_SPIPE (void)
	Ensure that this class is an abstract base class. More...

Protected Member Functions inherited from ACE_IPC_SAP
	ACE_IPC_SAP (void)
	Default constructor. More...

	~ACE_IPC_SAP (void)
	Protected destructor. More...

Protected Attributes inherited from ACE_SPIPE
ACE_SPIPE_Addr	local_addr_
	Our local address. More...

Detailed Description

Defines the method that transfer data on a UPIPE.

Member Typedef Documentation

typedef ACE_Stream<ACE_SYNCH> ACE_UPIPE_Stream::MT_Stream

typedef ACE_UPIPE_Addr ACE_UPIPE_Stream::PEER_ADDR

Constructor & Destructor Documentation

ACE_UPIPE_Stream::ACE_UPIPE_Stream ( void )

ACE_UPIPE_Stream::~ACE_UPIPE_Stream ( void )

virtual

Member Function Documentation

int ACE_UPIPE_Stream::close ( void )

Shut down the UPIPE and release resources.

int ACE_UPIPE_Stream::control	(	int	cmd,
		void *	val
	)		const

Perform control operations on the UPIPE_Stream.

void ACE_UPIPE_Stream::dump ( void ) const

Dump the state of an object.

ACE_HANDLE ACE_UPIPE_Stream::get_handle ( void ) const

inline

Return the underlying I/O handle.

int ACE_UPIPE_Stream::get_remote_addr ( ACE_UPIPE_Addr & remote_sap ) const

Return the remote address we are connected to.

int ACE_UPIPE_Stream::recv	(	ACE_Message_Block *&	mb_p,
		ACE_Time_Value *	timeout = `0`
	)

Recv a message from the message queue. Returns -1 on error, else 0.

ssize_t ACE_UPIPE_Stream::recv	(	char *	buffer,
		size_t	n,
		ACE_Time_Value *	timeout = `0`
	)

Recv a buffer of upto n bytes from the message queue. Returns -1 on error, else number of bytes read.

ssize_t ACE_UPIPE_Stream::recv_n	(	char *	buffer,
		size_t	n,
		ACE_Time_Value *	timeout = `0`
	)

Recv a buffer of exactly n bytes from the message queue. Returns -1 on error, else the number of bytes read.

int ACE_UPIPE_Stream::send	(	ACE_Message_Block *	mb_p,
		ACE_Time_Value *	timeout = `0`
	)

Send a message through the message queue. Returns -1 on error, else 0.

ssize_t ACE_UPIPE_Stream::send	(	const char *	buffer,
		size_t	n,
		ACE_Time_Value *	timeout = `0`
	)

Send a buffer of n bytes through the message queue. Returns -1 on error, else number of bytes sent.

ssize_t ACE_UPIPE_Stream::send_n	(	const char *	buffer,
		size_t	n,
		ACE_Time_Value *	timeout = `0`
	)

Send a buffer of exactly n bytes to the message queue. Returns -1 on error, else number of bytes written (which should == n).

Friends And Related Function Documentation

friend class ACE_UPIPE_Acceptor

friend

friend class ACE_UPIPE_Connector

friend

Member Data Documentation

ACE_UPIPE_Stream::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_Message_Block* ACE_UPIPE_Stream::mb_last_

private

To hold the last ACE_Message_Block read out of the stream. Thus allowing subsequent reads from one ACE_Message_Block

int ACE_UPIPE_Stream::reference_count_

private

Keep track of whether the sender and receiver have both shutdown.

ACE_UPIPE_Addr ACE_UPIPE_Stream::remote_addr_

private

Address of who we are connected to.

MT_Stream ACE_UPIPE_Stream::stream_

private

Stream component used by the UPIPE_Acceptor and UPIPE_Connector to link together two UPIPE_Streams.

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

Public Types

Public Member Functions

Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation