Public Types | Public Member Functions | Public Attributes

ACE_SOCK_Stream Class Reference

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

#include <SOCK_Stream.h>

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

List of all members.

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 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.
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.
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.

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

Definition at line 40 of file SOCK_Stream.h.

Member Typedef Documentation

typedef ACE_INET_Addr ACE_SOCK_Stream::PEER_ADDR

Definition at line 168 of file SOCK_Stream.h.

Constructor & Destructor Documentation

ACE_SOCK_Stream::ACE_SOCK_Stream ( void   ) 

Constructor.

Definition at line 11 of file SOCK_Stream.inl.

{
  // ACE_TRACE ("ACE_SOCK_Stream::ACE_SOCK_Stream");
}

ACE_SOCK_Stream::ACE_SOCK_Stream ( ACE_HANDLE  h  ) 

Constructor (sets the underlying ACE_HANDLE with h).

Definition at line 17 of file SOCK_Stream.inl.

{
  // ACE_TRACE ("ACE_SOCK_Stream::ACE_SOCK_Stream");
  this->set_handle (h);
}

ACE_SOCK_Stream::~ACE_SOCK_Stream ( void   ) 

Destructor.

Definition at line 24 of file SOCK_Stream.inl.

{
  // ACE_TRACE ("ACE_SOCK_Stream::~ACE_SOCK_Stream");
}

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).

Reimplemented from ACE_SOCK.

Definition at line 24 of file SOCK_Stream.cpp.

{
#if defined (ACE_WIN32)
  // We need the following call to make things work correctly on
  // Win32, which requires us to do a close_writer() before doing the
  // close() in order to avoid losing data.  Note that we don't need
  // to do this on UNIX since it doesn't have this "feature".
  // Moreover, this will cause subtle problems on UNIX due to the way
  // that fork() works.
  (void) this->close_writer ();
 #endif /* ACE_WIN32 */

  // Close down the socket.
  return ACE_SOCK::close ();
}

int ACE_SOCK_Stream::close_reader ( void   ) 

Close down the reader.

Definition at line 30 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::close_reader");
  if (this->get_handle () != ACE_INVALID_HANDLE)
    return ACE_OS::shutdown (this->get_handle (), ACE_SHUTDOWN_READ);
  else
    return 0;
}

int ACE_SOCK_Stream::close_writer ( void   ) 

Close down the writer.

Definition at line 42 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::close_writer");
  if (this->get_handle () != ACE_INVALID_HANDLE)
    return ACE_OS::shutdown (this->get_handle (), ACE_SHUTDOWN_WRITE);
  else
    return 0;
}

void ACE_SOCK_Stream::dump ( void   )  const

Dump the state of an object.

Reimplemented from ACE_SOCK_IO.

Definition at line 16 of file SOCK_Stream.cpp.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_SOCK_Stream::dump");
#endif /* ACE_HAS_DUMP */
}

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.

Definition at line 52 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::recv_n");
  return ACE::recv_n (this->get_handle (),
                      buf,
                      len,
                      flags,
                      timeout,
                      bytes_transferred);
}

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.

Definition at line 68 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::recv_n");
  return ACE::recv_n (this->get_handle (),
                      buf,
                      len,
                      timeout,
                      bytes_transferred);
}

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

Definition at line 165 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::recv_urg");
  return ACE::recv (this->get_handle (),
                    ptr,
                    len,
                    MSG_OOB,
                    timeout);
}

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.

Definition at line 82 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::recvv_n");
  return ACE::recvv_n (this->get_handle (),
                       iov,
                       n,
                       timeout,
                       bytes_transferred);
}

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.

Definition at line 96 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::send_n");
  return ACE::send_n (this->get_handle (),
                      buf,
                      len,
                      flags,
                      timeout,
                      bytes_transferred);
}

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.

Definition at line 112 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::send_n");
  return ACE::send_n (this->get_handle (),
                      buf,
                      len,
                      timeout,
                      bytes_transferred);
}

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 blocks chained through their next and cont pointers. This call uses the underlying OS gather-write operation to reduce the domain-crossing penalty.

Definition at line 140 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::send_n");
  return ACE::send_n (this->get_handle (),
                      message_block,
                      timeout,
                      bytes_transferred);
}

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

Definition at line 152 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::send_urg");
  return ACE::send (this->get_handle (),
                    ptr,
                    len,
                    MSG_OOB,
                    timeout);
}

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.

Definition at line 126 of file SOCK_Stream.inl.

{
  ACE_TRACE ("ACE_SOCK_Stream::sendv_n");
  return ACE::sendv_n (this->get_handle (),
                       iov,
                       n,
                       timeout,
                       bytes_transferred);
}

Member Data Documentation

ACE_SOCK_Stream::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_SOCK_IO.

Definition at line 174 of file SOCK_Stream.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Dec 9 2010 11:57:56 for ACE by  doxygen 1.7.0