#include <SOCK_Stream.h>
Inheritance diagram for ACE_SOCK_Stream:
Public Types | |
| typedef ACE_INET_Addr | PEER_ADDR |
Public Member Functions | |
| ACE_SOCK_Stream (void) | |
| Constructor. | |
| ACE_SOCK_Stream (ACE_HANDLE h) | |
| Constructor (sets the underlying ACE_HANDLE with h). | |
| ~ACE_SOCK_Stream (void) | |
| Destructor. | |
| 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. | |
| int | close_writer (void) |
| Close down the writer. | |
| int | close (void) |
| void | dump (void) const |
| Dump the state of an object. | |
Counted send/receive methods | |
The counted send/receive methods attempt to send 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. 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
Public Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. | |
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.
Reimplemented in ACE_LSOCK_Stream.
| ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_SOCK_Stream::ACE_SOCK_Stream | ( | void | ) |
Constructor.
| ACE_INLINE ACE_SOCK_Stream::ACE_SOCK_Stream | ( | ACE_HANDLE | h | ) |
Constructor (sets the underlying ACE_HANDLE with h).
| ACE_INLINE ACE_SOCK_Stream::~ACE_SOCK_Stream | ( | void | ) |
Destructor.
| 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).
Reimplemented from ACE_SOCK.
| ACE_INLINE int ACE_SOCK_Stream::close_reader | ( | void | ) |
Close down the reader.
| ACE_INLINE int ACE_SOCK_Stream::close_writer | ( | void | ) |
Close down the writer.
| ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_SOCK_Stream::dump | ( | void | ) | const |
| ACE_INLINE ssize_t ACE_SOCK_Stream::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.
| ACE_INLINE 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 |
Try to recv exactly len bytes into buf from the connected socket.
| ACE_INLINE ssize_t ACE_SOCK_Stream::recv_urg | ( | void * | ptr, | |
| size_t | len = sizeof(char), |
|||
| const ACE_Time_Value * | timeout = 0 | |||
| ) | const |
| ACE_INLINE ssize_t ACE_SOCK_Stream::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.
| ACE_INLINE 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 |
Send all the message_block's chained through their next and cont pointers. This call uses the underlying OS gather-write operation to reduce the domain-crossing penalty.
| ACE_INLINE 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 |
Try to send exactly len bytes from buf to the connected socket.
| ACE_INLINE 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 |
Try to send exactly len bytes from buf>to the connection socket.
| ACE_INLINE ssize_t ACE_SOCK_Stream::send_urg | ( | const void * | ptr, | |
| size_t | len = sizeof(char), |
|||
| const ACE_Time_Value * | timeout = 0 | |||
| ) | const |
| ACE_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 |
Send an iovec of size iovcnt to the connected socket.
Declare the dynamic allocation hooks.
Reimplemented from ACE_SOCK_IO.
Reimplemented in ACE_LSOCK_Stream.
1.4.7-1