Defines the methods in the ACE_SOCK_Stream abstraction. More...

#include <SOCK_Stream.h>

Inheritance diagram for ACE_SOCK_Stream:

Collaboration diagram for ACE_SOCK_Stream:

Public Types
typedef ACE_INET_Addr	PEER_ADDR

Public Member Functions

ACE_SOCK_Stream (void)

Constructor. More...

ACE_SOCK_Stream (ACE_HANDLE h)

Constructor (sets the underlying ACE_HANDLE with h). More...

~ACE_SOCK_Stream (void)

Destructor. More...

ssize_t send_urg (const void *ptr, size_t len=sizeof(char), const ACE_Time_Value *timeout=0) const

ssize_t recv_urg (void *ptr, size_t len=sizeof(char), const ACE_Time_Value *timeout=0) const

int close_reader (void)

Close down the reader. More...

int close_writer (void)

Close down the writer. More...

int close (void)

void dump (void) const

Dump the state of an object. More...

Counted send/receive methods

The counted send/receive methods attempt to transfer a specified number of bytes even if they must block and retry the operation in order to transfer the entire amount. The time spent blocking for the entire transfer can be limited by a specified ACE_Time_Value object which is a relative time (i.e., a fixed amount of time, not an absolute time of day). These methods return the count of transferred bytes, or -1 if an error occurs or the operation times out before the entire requested amount of data has been transferred. In error or timeout situations it's possible that some data was transferred before the error or timeout. The bytes_transferred parameter is used to obtain the count of bytes transferred before the error or timeout occurred. If the total specified number of bytes is transferred without error, the method return value should equal the value of bytes_transferred.

Parameters

buf	The buffer to write from or receive into.
iov	An I/O vector containing a specified number of count/pointer pairs directing the data to be transferred.
iovcnt	The number of I/O vectors to be used from iov.
len	The number of bytes to transfer.
flags	Flags that will be passed through to the `recv()` system call.
timeout	Indicates how long to blocking trying to transfer data. If no timeout is supplied (timeout == 0) the method will wait indefinitely or until an error occurs for the specified number of bytes to be transferred. To avoid any waiting, specify a timeout value with 0 seconds. Note that the timeout period restarts on each retried operation issued; therefore, an operation that requires multiples retries may take longer than the specified timeout to complete.
bytes_transferred	If non-0, points to a location which receives the total number of bytes transferred before the method returns, even if it's less than the number requested.

Return values

len,the	complete number of bytes transferred.
0	EOF, i.e., the peer closed the connection.
-1	an error occurred before the entire amount was transferred. Check `errno` for more information. If the timeout period is reached, errno is ETIME.

On partial transfers, i.e., if any data is transferred before timeout/error/EOF, *bytes_transferred will contain the number of bytes transferred.

ssize_t recv_n (void *buf, size_t len, int flags, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Try to recv exactly len bytes into buf from the connected socket. More...

ssize_t recv_n (void *buf, size_t len, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Try to recv exactly len bytes into buf from the connected socket. More...

ssize_t recvv_n (iovec iov[], int iovcnt, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Receive an iovec of size iovcnt from the connected socket. More...

ssize_t send_n (const void *buf, size_t len, int flags, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Try to send exactly len bytes from buf to the connection socket. More...

ssize_t send_n (const void *buf, size_t len, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Try to send exactly len bytes from buf to the connected socket. More...

ssize_t send_n (const ACE_Message_Block *message_block, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

ssize_t sendv_n (const iovec iov[], int iovcnt, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const

Send an iovec of size iovcnt to the connected socket. More...

Public Member Functions inherited from ACE_SOCK_IO

ACE_SOCK_IO (void)

Constructor. More...

~ACE_SOCK_IO (void)

Destructor. More...

ssize_t recv (void *buf, size_t n, int flags, const ACE_Time_Value *timeout=0) const

Recv an n byte buffer from the connected socket. More...

ssize_t recv (void *buf, size_t n, const ACE_Time_Value *timeout=0) const

Recv an n byte buffer from the connected socket. More...

ssize_t recvv (iovec iov[], int n, const ACE_Time_Value *timeout=0) const

Recv an <iovec> of size n from the connected socket. More...

ssize_t recvv (iovec *io_vec, const ACE_Time_Value *timeout=0) const

ssize_t recv (size_t n,...) const

Recv n varargs messages to the connected socket. More...

ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const

Recv n bytes via Win32 ReadFile using overlapped I/O. More...

ssize_t send (const void *buf, size_t n, int flags, const ACE_Time_Value *timeout=0) const

Send an n byte buffer to the connected socket. More...

ssize_t send (const void *buf, size_t n, const ACE_Time_Value *timeout=0) const

Send an n byte buffer to the connected socket. More...

ssize_t sendv (const iovec iov[], int n, const ACE_Time_Value *timeout=0) const

Send an iovec of size n to the connected socket. More...

ssize_t send (size_t n,...) const

Send n varargs messages to the connected socket. More...

ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const

Send n bytes via Win32 <WriteFile> using overlapped I/O. More...

void dump (void) const

Dump the state of an object. More...

Public Member Functions inherited from ACE_SOCK

int set_option (int level, int option, void *optval, int optlen) const

Wrapper around the setsockopt system call. More...

int get_option (int level, int option, void *optval, int *optlen) const

Wrapper around the getsockopt system call. More...

int close (void)

int get_local_addr (ACE_Addr &) const

int get_remote_addr (ACE_Addr &) const

void dump (void) const

Dump the state of an object. More...

int open (int type, int protocol_family, int protocol, int reuse_addr)

Wrapper around the BSD-style socket system call (no QoS). More...

int open (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)

Wrapper around the QoS-enabled WSASocket function. 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_SOCK_IO
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Public Attributes inherited from ACE_SOCK
	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...

Additional Inherited Members
Protected Member Functions inherited from ACE_SOCK
	ACE_SOCK (int type, int protocol_family, int protocol=0, int reuse_addr=0)

	ACE_SOCK (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)

	ACE_SOCK (void)

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

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

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

Detailed Description

Defines the methods in the ACE_SOCK_Stream abstraction.

This adds additional wrapper methods atop the ACE_SOCK_IO class.

See also: ACE_SOCK_IO

Member Typedef Documentation

typedef ACE_INET_Addr ACE_SOCK_Stream::PEER_ADDR

Constructor & Destructor Documentation

ACE_SOCK_Stream::ACE_SOCK_Stream ( void )

inline

Constructor.

ACE_SOCK_Stream::ACE_SOCK_Stream ( ACE_HANDLE h )

inline

Constructor (sets the underlying ACE_HANDLE with h).

ACE_SOCK_Stream::~ACE_SOCK_Stream ( void )

inline

Destructor.

Member Function Documentation

int ACE_SOCK_Stream::close ( void )

Close down the socket (we need this to make things work correctly on Win32, which requires use to do a close_writer() before doing the close to avoid losing data).

int ACE_SOCK_Stream::close_reader ( void )

inline

Close down the reader.

int ACE_SOCK_Stream::close_writer ( void )

inline

Close down the writer.

void ACE_SOCK_Stream::dump ( void ) const

Dump the state of an object.

ssize_t ACE_SOCK_Stream::recv_n	(	void *	buf,
		size_t	len,
		int	flags,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Try to recv exactly len bytes into buf from the connected socket.

ssize_t ACE_SOCK_Stream::recv_n	(	void *	buf,
		size_t	len,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Try to recv exactly len bytes into buf from the connected socket.

ssize_t ACE_SOCK_Stream::recv_urg	(	void *	ptr,
		size_t	len = `sizeof (char)`,
		const ACE_Time_Value *	timeout = `0`
	)		const

inline

ssize_t ACE_SOCK_Stream::recvv_n	(	iovec	iov[],
		int	iovcnt,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Receive an iovec of size iovcnt from the connected socket.

ssize_t ACE_SOCK_Stream::send_n	(	const void *	buf,
		size_t	len,
		int	flags,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Try to send exactly len bytes from buf to the connection socket.

ssize_t ACE_SOCK_Stream::send_n	(	const void *	buf,
		size_t	len,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Try to send exactly len bytes from buf to the connected socket.

ssize_t ACE_SOCK_Stream::send_n	(	const ACE_Message_Block *	message_block,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Send all the message blocks chained through their next and cont pointers. This call uses the underlying OS gather-write operation to reduce the domain-crossing penalty.

ssize_t ACE_SOCK_Stream::send_urg	(	const void *	ptr,
		size_t	len = `sizeof (char)`,
		const ACE_Time_Value *	timeout = `0`
	)		const

inline

ssize_t ACE_SOCK_Stream::sendv_n	(	const iovec	iov[],
		int	iovcnt,
		const ACE_Time_Value *	timeout = `0`,
		size_t *	bytes_transferred = `0`
	)		const

inline

Send an iovec of size iovcnt to the connected socket.

Member Data Documentation

ACE_SOCK_Stream::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation