Public Types | Public Member Functions | Public Attributes | Private Attributes | Friends

ACE_SPIPE_Stream Class Reference

Defines the methods in the ACE_SPIPE_Stream abstraction. More...

#include <SPIPE_Stream.h>

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

List of all members.

Public Types

typedef ACE_SPIPE_Addr PEER_ADDR

Public Member Functions

 ACE_SPIPE_Stream (void)
 Default constructor.
int get_remote_addr (ACE_SPIPE_Addr &remote_sap) const
 Obtain the address of whom we are connected with.
int send_handle (ACE_HANDLE handle) const
 Send an open FD to another process.
int recv_handle (ACE_HANDLE &handle) const
 Recv an open FD from another process.
int recv_handle (strrecvfd &recvfd) const
 Recv an open FD from another process.
ssize_t send_n (const void *buf, size_t len) const
 Send len bytes, keep trying until len are sent.
ssize_t recv_n (void *buf, size_t len) const
 Recv len bytes, keep trying until len are received.
ssize_t send (const void *buf, size_t len) const
 Send bytes via STREAM pipes using "band" mode.
ssize_t recv (void *buf, size_t len) const
 Recv bytes via STREAM pipes using "band" mode.
ssize_t send (const ACE_Str_Buf *cntl, const ACE_Str_Buf *data, int flags=0) const
 Send cntl and data via STREAM pipes.
ssize_t recv (ACE_Str_Buf *cntl, ACE_Str_Buf *data, int *flags) const
 Recv cntl and data via STREAM pipes.
ssize_t send (const ACE_Str_Buf *cntl, const ACE_Str_Buf *data, int band, int flags) const
 Send bytes via STREAM pipes using "band" mode.
ssize_t recv (ACE_Str_Buf *cntl, ACE_Str_Buf *data, int *band, int *flags) const
 Recv bytes via STREAM pipes using "band" mode.
ssize_t send (const iovec iov[], int len) const
 Send iovecs via the OS "gather-write" operation.
ssize_t recv (iovec iov[], int len) const
 Recv iovecs via the OS "scatter-read" operation.
ssize_t send (size_t len,...) const
ssize_t recv (size_t len,...) const
ssize_t send (const void *buf, size_t len, ACE_OVERLAPPED *overlapped) const
 Send len bytes via Win32 <WriteFile> using overlapped I/O.
ssize_t recv (void *buf, size_t len, ACE_OVERLAPPED *overlapped) const
 Recv len bytes via Win32 <ReadFile> using overlapped I/O.
ssize_t sendv (const iovec iov[], int len) const
 Send an <iovec> of size len to the stream.
ssize_t sendv_n (const iovec iov[], int len) const
ssize_t recvv_n (iovec iov[], int len) const
 Receive an <iovec> of size len from the stream.
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Private Attributes

ACE_SPIPE_Addr remote_addr_

Friends

class ACE_SPIPE_Acceptor
class ACE_SPIPE_Connector

Detailed Description

Defines the methods in the ACE_SPIPE_Stream abstraction.

buf is the buffer to write from or receive into. len is the number of bytes to transfer.

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.

The return values for the "*_n()" methods match the return values from the non "_n()" methods and are specified as follows:

Methods with <iovec> parameter are I/O vector variants of the I/O operations.

The <send> and <revc> operations use "message" semantics rather than "bytestream" semantics.

Definition at line 53 of file SPIPE_Stream.h.

Member Typedef Documentation

typedef ACE_SPIPE_Addr ACE_SPIPE_Stream::PEER_ADDR

Definition at line 152 of file SPIPE_Stream.h.

Constructor & Destructor Documentation

ACE_SPIPE_Stream::ACE_SPIPE_Stream ( void   ) 

Default constructor.

Definition at line 26 of file SPIPE_Stream.cpp.

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

Member Function Documentation

void ACE_SPIPE_Stream::dump ( void   )  const

Dump the state of an object.

Reimplemented from ACE_SPIPE.

Definition at line 17 of file SPIPE_Stream.cpp.

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

int ACE_SPIPE_Stream::get_remote_addr ( ACE_SPIPE_Addr &  remote_sap  )  const

Obtain the address of whom we are connected with.

Definition at line 17 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::get_remote_addr");
  remote_sap = this->remote_addr_;
  return 0;
}

ssize_t ACE_SPIPE_Stream::recv ( size_t  len,
  ... 
) const

This is an interface to readv, that doesn't use the struct iovec explicitly. The ... can be passed as an arbitrary number of (char *ptr, int len) tuples. However, the count N is the *total* number of trailing arguments, *not* a couple of the number of tuple pairs!

Definition at line 74 of file SPIPE_Stream.cpp.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  va_list argp;
  int total_tuples = static_cast<int> (n / 2);
  iovec *iovp;
#if defined (ACE_HAS_ALLOCA)
  iovp = (iovec *) alloca (total_tuples * sizeof (iovec));
#else
  ACE_NEW_RETURN (iovp,
                  iovec[total_tuples],
                  -1);
#endif /* !defined (ACE_HAS_ALLOCA) */

  va_start (argp, n);

  for (int i = 0; i < total_tuples; i++)
    {
      iovp[i].iov_base = va_arg (argp, char *);
      iovp[i].iov_len  = va_arg (argp, int);
    }

  ssize_t result = ACE_OS::readv (this->get_handle (), iovp, total_tuples);
#if !defined (ACE_HAS_ALLOCA)
  delete [] iovp;
#endif /* !defined (ACE_HAS_ALLOCA) */
  va_end (argp);
  return result;
}

ssize_t ACE_SPIPE_Stream::recv ( void *  buf,
size_t  len,
ACE_OVERLAPPED *  overlapped 
) const

Recv len bytes via Win32 <ReadFile> using overlapped I/O.

Definition at line 229 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  return ACE_OS::read (this->get_handle (),
                       (char *) buf, n,
                       overlapped);
}

ssize_t ACE_SPIPE_Stream::recv ( void *  buf,
size_t  len 
) const

Recv bytes via STREAM pipes using "band" mode.

Definition at line 52 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  return ACE_OS::read (this->get_handle (), (char *) buf, n);
}

ssize_t ACE_SPIPE_Stream::recv ( ACE_Str_Buf *  cntl,
ACE_Str_Buf *  data,
int *  flags 
) const

Recv cntl and data via STREAM pipes.

Definition at line 66 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  return ACE_OS::getmsg (this->get_handle (), (strbuf *) cntl, (strbuf *) data, flags);
}

ssize_t ACE_SPIPE_Stream::recv ( ACE_Str_Buf *  cntl,
ACE_Str_Buf *  data,
int *  band,
int *  flags 
) const

Recv bytes via STREAM pipes using "band" mode.

Definition at line 80 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  return ACE_OS::getpmsg (this->get_handle (), (strbuf *) cntl, (strbuf *) data, band, flags);
}

ssize_t ACE_SPIPE_Stream::recv ( iovec  iov[],
int  len 
) const

Recv iovecs via the OS "scatter-read" operation.

Definition at line 94 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv");
  return ACE_OS::readv (this->get_handle (), iov, n);
}

int ACE_SPIPE_Stream::recv_handle ( strrecvfd &  recvfd  )  const

Recv an open FD from another process.

Definition at line 207 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv_handle");
#if defined (ACE_HAS_STREAM_PIPES)
  return ACE_OS::ioctl (this->get_handle (), I_RECVFD, (void *) &recvfd);
#else
  ACE_UNUSED_ARG (recvfd);
  ACE_NOTSUP_RETURN (-1);
#endif /* ACE_HAS_STREAM_PIPES */
}

int ACE_SPIPE_Stream::recv_handle ( ACE_HANDLE &  handle  )  const

Recv an open FD from another process.

Definition at line 150 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv_handle");
#if defined (ACE_HAS_STREAM_PIPES)
  strrecvfd recvfd;

  if (ACE_OS::ioctl (this->get_handle (), I_RECVFD, (void *) &recvfd) == -1)
    return -1;
  else
    {
      handle = recvfd.fd;
      return 0;
    }
#elif defined (ACE_WIN32) && \
      (defined (ACE_HAS_WINSOCK2) && (ACE_HAS_WINSOCK2 != 0))
  pid_t procID = ACE_OS::getpid();
  WSAPROTOCOL_INFO protInfo;
  ssize_t res = this->send(&procID, sizeof(procID));
  if (res != static_cast <ssize_t> (sizeof(procID)))
  {
    if(res != -1)
        errno = ENXIO;
    return -1;
  }
  res = this->recv(&protInfo, sizeof(protInfo));
  if (res != static_cast <ssize_t> (sizeof(protInfo)))
  {
    if(res != -1)
        errno = ENXIO;
     return -1;
  }
  handle = ACE_OS::socket (FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
                           &protInfo, 0, 0);
  if (handle == ACE_INVALID_HANDLE)
  {
    return -1;
  }
  // Since it does not matter what the data is, just send something to
  // synchronize the end of the exchange
  res = this->send(&procID, sizeof(procID));
  if (res != static_cast <ssize_t> (sizeof(procID)))
  {
    if(res != -1)
        errno = ENXIO;
    return -1;
  }
  return 0;
#else
  handle = handle;
  ACE_NOTSUP_RETURN (-1);
#endif /* ACE_HAS_STREAM_PIPES */
}

ssize_t ACE_SPIPE_Stream::recv_n ( void *  buf,
size_t  len 
) const

Recv len bytes, keep trying until len are received.

Definition at line 38 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recv_n");
  return ACE::read_n (this->get_handle (), buf, n);
}

ssize_t ACE_SPIPE_Stream::recvv_n ( iovec  iov[],
int  len 
) const

Receive an <iovec> of size len from the stream.

Definition at line 251 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::recvv_n");
  // @@ Carlos, can you please update this to call the
  // new ACE::recvv_n() method that you write?
  return ACE_OS::readv (this->get_handle (),
                        iov,
                        n);
}

ssize_t ACE_SPIPE_Stream::send ( const ACE_Str_Buf *  cntl,
const ACE_Str_Buf *  data,
int  flags = 0 
) const

Send cntl and data via STREAM pipes.

Definition at line 59 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send");
  return ACE_OS::putmsg (this->get_handle (), (strbuf *) cntl, (strbuf *) data, flags);
}

ssize_t ACE_SPIPE_Stream::send ( const void *  buf,
size_t  len,
ACE_OVERLAPPED *  overlapped 
) const

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

Definition at line 219 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send");
  return ACE_OS::write (this->get_handle (),
                        (const char *) buf, n,
                        overlapped);
}

ssize_t ACE_SPIPE_Stream::send ( const ACE_Str_Buf *  cntl,
const ACE_Str_Buf *  data,
int  band,
int  flags 
) const

Send bytes via STREAM pipes using "band" mode.

Definition at line 73 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send");
  return ACE_OS::putpmsg (this->get_handle (), (strbuf *) cntl, (strbuf *) data, band, flags);
}

ssize_t ACE_SPIPE_Stream::send ( size_t  len,
  ... 
) const

Send N char *ptrs and int lengths. Note that the char *'s precede the ints (basically, an varargs version of writev). The count N is the *total* number of trailing arguments, *not* a couple of the number of tuple pairs!

Definition at line 37 of file SPIPE_Stream.cpp.

{
  // ACE_TRACE ("ACE_SPIPE_Stream::send");
  va_list argp;
  int total_tuples = static_cast<int> (n / 2);
  iovec *iovp;
#if defined (ACE_HAS_ALLOCA)
  iovp = (iovec *) alloca (total_tuples * sizeof (iovec));
#else
  ACE_NEW_RETURN (iovp,
                  iovec[total_tuples],
                  -1);
#endif /* !defined (ACE_HAS_ALLOCA) */

  va_start (argp, n);

  for (int i = 0; i < total_tuples; i++)
    {
      iovp[i].iov_base = va_arg (argp, char *);
      iovp[i].iov_len  = va_arg (argp, int);
    }

  ssize_t result = ACE_OS::writev (this->get_handle (), iovp, total_tuples);
#if !defined (ACE_HAS_ALLOCA)
  delete [] iovp;
#endif /* !defined (ACE_HAS_ALLOCA) */
  va_end (argp);
  return result;
}

ssize_t ACE_SPIPE_Stream::send ( const void *  buf,
size_t  len 
) const

Send bytes via STREAM pipes using "band" mode.

Definition at line 45 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send");
  return ACE_OS::write (this->get_handle (), (const char *) buf, n);
}

ssize_t ACE_SPIPE_Stream::send ( const iovec  iov[],
int  len 
) const

Send iovecs via the OS "gather-write" operation.

Definition at line 87 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send");
  return ACE_OS::writev (this->get_handle (), iov, n);
}

int ACE_SPIPE_Stream::send_handle ( ACE_HANDLE  handle  )  const

Send an open FD to another process.

Definition at line 103 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send_handle");
#if defined (ACE_HAS_STREAM_PIPES)
  return ACE_OS::ioctl (this->get_handle (), I_SENDFD, (void *) handle);
#elif defined (ACE_WIN32) && \
      (defined (ACE_HAS_WINSOCK2) && (ACE_HAS_WINSOCK2 != 0)) && \
       !defined (ACE_HAS_WINCE)   /* CE4 has WS2 but not WSADuplicateSocket */
  DWORD procID;
  WSAPROTOCOL_INFO protInfo;
  ssize_t res = this->recv(&procID, sizeof(procID));
  if (res != static_cast <ssize_t> (sizeof(procID)))
  {
    if(res != -1)
        errno = ENXIO;
    return -1;
  }
  if (::WSADuplicateSocket ((SOCKET)handle, procID, &protInfo) == -1)
  {
    ACE_OS::set_errno_to_wsa_last_error();
      return -1;
  }
  res = this->send(&protInfo, sizeof(protInfo));
  if (res != static_cast <ssize_t> (sizeof(protInfo)))
  {
    if(res != -1)
        errno = ENXIO;
    return -1;
  }
  // This is just for synchronization, we will ignore the data
  res = this->recv(&procID, sizeof(procID));
  if (res != static_cast <ssize_t> (sizeof(procID)))
  {
    if(res != -1)
        errno = ENXIO;
    return -1;
  }
  return 0;
#else
  handle = handle;
  ACE_NOTSUP_RETURN (-1);
#endif /* ACE_HAS_STREAM_PIPES */
}

ssize_t ACE_SPIPE_Stream::send_n ( const void *  buf,
size_t  len 
) const

Send len bytes, keep trying until len are sent.

Definition at line 28 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::send_n");
  return ACE::write_n (this->get_handle (), buf, n);
}

ssize_t ACE_SPIPE_Stream::sendv ( const iovec  iov[],
int  len 
) const

Send an <iovec> of size len to the stream.

Definition at line 265 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::sendv");
  return ACE_OS::writev (this->get_handle (),
                         iov,
                         n);
}

ssize_t ACE_SPIPE_Stream::sendv_n ( const iovec  iov[],
int  len 
) const

Send an <iovec> of size len to the stream. Will block until all bytes are sent or an error occurs.

Definition at line 239 of file SPIPE_Stream.inl.

{
  ACE_TRACE ("ACE_SPIPE_Stream::sendv_n");
  return ACE::writev_n (this->get_handle (),
                        iov,
                        n);
}

Friends And Related Function Documentation

friend class ACE_SPIPE_Acceptor [friend]

Definition at line 56 of file SPIPE_Stream.h.

friend class ACE_SPIPE_Connector [friend]

Definition at line 57 of file SPIPE_Stream.h.

Member Data Documentation

ACE_SPIPE_Stream::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_SPIPE.

Definition at line 158 of file SPIPE_Stream.h.

ACE_SPIPE_Addr ACE_SPIPE_Stream::remote_addr_ [private]

Definition at line 161 of file SPIPE_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