ACE  6.3.3
Public Types | Public Member Functions | Public Attributes | List of all members
ACE_SOCK_SEQPACK_Association Class Reference

Defines the methods in the ACE_SOCK_SEQPACK_Association abstraction. More...

#include <SOCK_SEQPACK_Association.h>

Inheritance diagram for ACE_SOCK_SEQPACK_Association:
Inheritance graph
[legend]
Collaboration diagram for ACE_SOCK_SEQPACK_Association:
Collaboration graph
[legend]

Public Types

typedef ACE_Multihomed_INET_Addr PEER_ADDR
 

Public Member Functions

 ACE_SOCK_SEQPACK_Association (void)
 Constructor. More...
 
 ACE_SOCK_SEQPACK_Association (ACE_HANDLE h)
 Constructor (sets the underlying ACE_HANDLE with <h>). More...
 
 ~ACE_SOCK_SEQPACK_Association (void)
 Destructor. More...
 
int get_local_addrs (ACE_INET_Addr *addrs, size_t &size) const
 
int get_remote_addrs (ACE_INET_Addr *addrs, size_t &size) const
 
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...
 
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)
 
int abort (void)
 
void dump (void) const
 Dump the state of an object. 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_SEQPACK_Association abstraction.

This adds additional wrapper methods atop the <ACE_SOCK_IO> class.

buf is the buffer to write from or receive into. len is the number of bytes to transfer. The timeout parameter in the following methods indicates how long to blocking trying to transfer data. If timeout == 0, then the call behaves as a normal send/recv call, i.e., for blocking sockets, the call will block until action is possible; for non-blocking sockets, EWOULDBLOCK will be returned if no action is immediately possible. If timeout != 0, the call will wait for data to arrive no longer than the relative time specified in *timeout. The "_n()" I/O methods keep looping until all the data has been transferred. These methods also work for sockets in non-blocking mode i.e., they keep looping on EWOULDBLOCK. timeout is used to make sure we keep making progress, i.e., the same timeout value is used for every I/O operation in the loop and the timeout is not counted down. The return values for the "*_n()" methods match the return values from the non "_n()" methods and are specified as follows:

On partial transfers, i.e., if any data is transferred before timeout/error/EOF, <bytes_transferred> will contain the number of bytes transferred. Methods with <iovec> parameter are I/O vector variants of the I/O operations. Methods with the extra flags argument will always result in <send> getting called. Methods without the extra flags argument will result in <send> getting called on Win32 platforms, and <write> getting called on non-Win32 platforms.

Member Typedef Documentation

Constructor & Destructor Documentation

ACE_SOCK_SEQPACK_Association::ACE_SOCK_SEQPACK_Association ( void  )
inline

Constructor.

ACE_SOCK_SEQPACK_Association::ACE_SOCK_SEQPACK_Association ( ACE_HANDLE  h)
inline

Constructor (sets the underlying ACE_HANDLE with <h>).

ACE_SOCK_SEQPACK_Association::~ACE_SOCK_SEQPACK_Association ( void  )
inline

Destructor.

Member Function Documentation

int ACE_SOCK_SEQPACK_Association::abort ( void  )

Abort the association according to RFC 2960 9.1 through the API in draft-ietf-tsvwg-sctpsocket-09 7.1.4.

int ACE_SOCK_SEQPACK_Association::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_SEQPACK_Association::close_reader ( void  )
inline

Close down the reader.

int ACE_SOCK_SEQPACK_Association::close_writer ( void  )
inline

Close down the writer.

void ACE_SOCK_SEQPACK_Association::dump ( void  ) const

Dump the state of an object.

int ACE_SOCK_SEQPACK_Association::get_local_addrs ( ACE_INET_Addr addrs,
size_t &  size 
) const

Return local endpoint addresses in the referenced array of ACE_INET_Addr, which should have the specified size. If the number of local endpoint addresses is less than size, then size will be set to this number. If successful, the method returns 0, otherwise returns -1.

int ACE_SOCK_SEQPACK_Association::get_remote_addrs ( ACE_INET_Addr addrs,
size_t &  size 
) const

Return remote endpoint addresses in the referenced array of ACE_INET_Addr, which should have the specified size. If the number of remote endpoint addresses is less than size, then size will be set to this number. If successful, the method returns 0, otherwise returns -1.

ssize_t ACE_SOCK_SEQPACK_Association::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_SEQPACK_Association::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_SEQPACK_Association::recv_urg ( void *  ptr,
size_t  len = sizeof (char),
const ACE_Time_Value timeout = 0 
) const
inline
ssize_t ACE_SOCK_SEQPACK_Association::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_SEQPACK_Association::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_SEQPACK_Association::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_SEQPACK_Association::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_SEQPACK_Association::send_urg ( const void *  ptr,
size_t  len = sizeof (char),
const ACE_Time_Value timeout = 0 
) const
inline
ssize_t ACE_SOCK_SEQPACK_Association::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_SEQPACK_Association::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.


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