ACE/ace/SPIPE_Stream.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    SPIPE_Stream.h
   6  *
   7  *  @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_SPIPE_STREAM_H
  12 #define ACE_SPIPE_STREAM_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include "ace/SPIPE.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "ace/SPIPE_Addr.h"
  22 #include "ace/ACE.h"
  23 #include "ace/OS_NS_stropts.h"
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 /**
  28  * @class ACE_SPIPE_Stream
  29  *
  30  * @brief Defines the methods in the ACE_SPIPE_Stream abstraction.
  31  *
  32  * @a buf is the buffer to write from or receive into.
  33  * @a len is the number of bytes to transfer.
  34  *
  35  * The "_n()" I/O methods keep looping until all the data has been
  36  * transferred.  These methods also work for sockets in non-blocking
  37  * mode i.e., they keep looping on EWOULDBLOCK.
  38  *
  39  * The return values for the "*_n()" methods match the return values
  40  * from the non "_n()" methods and are specified as follows:
  41  * - The number of bytes transferred is returned.
  42  * - On error, -1 is returned, errno is set to appropriate error.
  43  * - On EOF, 0 is returned, errno is irrelevant.
  44  *
  45  * Methods with <iovec> parameter are I/O vector variants of the I/O
  46  * operations.
  47  *
  48  * The <send> and <revc> operations use "message" semantics rather
  49  * than "bytestream" semantics.
  50  */
  51 class ACE_Export ACE_SPIPE_Stream : public ACE_SPIPE
  52 {
  53 public:
  54   friend class ACE_SPIPE_Acceptor;
  55   friend class ACE_SPIPE_Connector;
  56
  57   /// Default constructor.
  58   ACE_SPIPE_Stream (void);
  59
  60   /// Obtain the address of whom we are connected with.
  61   int get_remote_addr (ACE_SPIPE_Addr &remote_sap) const;
  62
  63   /// Send an open FD to another process.
  64   int send_handle (ACE_HANDLE handle) const;
  65
  66   /// Recv an open FD from another process.
  67   int recv_handle (ACE_HANDLE &handle) const;
  68
  69   /// Recv an open FD from another process.
  70   int recv_handle (strrecvfd &recvfd) const;
  71
  72   /// Send @a len bytes, keep trying until @a len are sent.
  73   ssize_t send_n (const void *buf, size_t len) const;
  74
  75   /// Recv @a len bytes, keep trying until @a len are received.
  76   ssize_t recv_n (void *buf, size_t len) const;
  77
  78   /// Send bytes via STREAM pipes using "band" mode.
  79   ssize_t send (const void *buf, size_t len) const;
  80
  81   /// Recv bytes via STREAM pipes using "band" mode.
  82   ssize_t recv (void *buf, size_t len) const;
  83
  84   /// Send @a cntl and @a data via STREAM pipes.
  85   ssize_t send (const ACE_Str_Buf *cntl,
  86                 const ACE_Str_Buf *data,
  87                 int flags = 0) const;
  88
  89   /// Recv @a cntl and @a data via STREAM pipes.
  90   ssize_t recv (ACE_Str_Buf *cntl,
  91                 ACE_Str_Buf *data,
  92                 int *flags) const;
  93
  94   /// Send bytes via STREAM pipes using "band" mode.
  95   ssize_t send (const ACE_Str_Buf *cntl,
  96                 const ACE_Str_Buf *data,
  97                 int band,
  98                 int flags) const;
  99
 100   /// Recv bytes via STREAM pipes using "band" mode.
 101   ssize_t recv (ACE_Str_Buf *cntl,
 102                 ACE_Str_Buf *data,
 103                 int *band,
 104                 int *flags) const;
 105
 106   /// Send iovecs via the OS "gather-write" operation.
 107   ssize_t send (const iovec iov[], int len) const;
 108
 109   /// Recv iovecs via the OS "scatter-read" operation.
 110   ssize_t recv (iovec iov[], int len) const;
 111
 112 #ifndef ACE_LACKS_VA_FUNCTIONS
 113   /**
 114    * Send N char *ptrs and int lengths.  Note that the char *'s
 115    * precede the ints (basically, an varargs version of writev).  The
 116    * count N is the *total* number of trailing arguments, *not* a
 117    * couple of the number of tuple pairs!
 118    */
 119   ssize_t send (size_t len, ...) const;
 120
 121   /**
 122    * This is an interface to ::readv, that doesn't use the struct
 123    * iovec explicitly.  The ... can be passed as an arbitrary number
 124    * of (char *ptr, int len) tuples.  However, the count N is the
 125    * *total* number of trailing arguments, *not* a couple of the
 126    * number of tuple pairs!
 127    */
 128   ssize_t recv (size_t len, ...) const;
 129 #endif
 130
 131   /// Send @a len bytes via Win32 <WriteFile> using overlapped I/O.
 132   ssize_t send (const void *buf, size_t len, ACE_OVERLAPPED *overlapped) const;
 133
 134   /// Recv @a len bytes via Win32 <ReadFile> using overlapped I/O.
 135   ssize_t recv (void *buf, size_t len, ACE_OVERLAPPED *overlapped) const;
 136
 137   /// Send an <iovec> of size @a len to the stream.
 138   ssize_t sendv (const iovec iov[],
 139                  int len) const;
 140
 141   /// Send an <iovec> of size @a len to the stream.  Will block until all
 142   /// bytes are sent or an error occurs.
 143   ssize_t sendv_n (const iovec iov[],
 144                    int len) const;
 145
 146   /// Receive an <iovec> of size @a len from the stream.
 147   ssize_t recvv_n (iovec iov[],
 148                    int len) const;
 149
 150   // = Meta-type info
 151   typedef ACE_SPIPE_Addr PEER_ADDR;
 152
 153   /// Dump the state of an object.
 154   void dump (void) const;
 155
 156   /// Declare the dynamic allocation hooks.
 157   ACE_ALLOC_HOOK_DECLARE;
 158
 159 private:
 160   ACE_SPIPE_Addr remote_addr_;
 161 };
 162
 163 ACE_END_VERSIONED_NAMESPACE_DECL
 164
 165 #if defined (__ACE_INLINE__)
 166 #include "ace/SPIPE_Stream.inl"
 167 #endif /* __ACE_INLINE__ */
 168
 169 #include /**/ "ace/post.h"
 170 #endif /* ACE_SPIPE_STREAM_H */