ChangeLogTag:Thu Feb 10 13:49:34 2000 Nanbor Wang <nanbor@cs.wustl.edu>

1 files changed, 126 insertions, 0 deletions

diff --git a/ace/MEM_Stream.h b/ace/MEM_Stream.h
new file mode 100644
index 00000000000..f31b6cbec2c
--- /dev/null
+++ b/ace/MEM_Stream.h
@@ -0,0 +1,126 @@
+/* -*- C++ -*- */
+// $Id$
+
+// ============================================================================
+//
+// = LIBRARY
+//    ace
+//
+// = FILENAME
+//    MEM_Stream.h
+//
+// = AUTHOR
+//    Nanbor Wang
+//
+// ============================================================================
+
+#ifndef ACE_MEM_STREAM_H
+#define ACE_MEM_STREAM_H
+
+#include "ace/MEM_IO.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+#include "ace/INET_Addr.h"
+
+class ACE_MEM_Acceptor;
+class ACE_MEM_Connector;
+
+class ACE_Export ACE_MEM_Stream : public ACE_MEM_IO
+{
+  // = TITLE
+  //     Defines the methods in the <ACE_MEM_Stream> abstraction.
+  //
+  // = DESCRIPTION
+  //     This adds additional wrapper methods atop the <ACE_MEM_IO>
+  //     class.
+public:
+
+  friend class ACE_MEM_Acceptor;
+  friend class ACE_MEM_Connector;
+
+  // Initialization and termination methods.
+  ACE_MEM_Stream (void);
+  // Constructor.
+
+  ACE_MEM_Stream (ACE_HANDLE h);
+  // Constructor (sets the underlying <ACE_HANDLE> with <h>).
+
+  ~ACE_MEM_Stream (void);
+  // Destructor.
+
+  //= The following two methods use write and read system calls.
+  ssize_t send_n (const void *buf, int n);
+  // Send n bytes, keep trying until n are sent.
+  ssize_t recv_n (void *buf, int n);
+  // Recv n bytes, keep trying until n are received.
+
+  // = The following two methods use the send and recv system calls.
+  ssize_t send_n (const void *buf, int n, int flags);
+  // Send n bytes, keep trying until n are sent.
+  ssize_t recv_n (void *buf, int n, int flags);
+  // Recv n bytes, keep trying until n are received.
+
+/*
+  ssize_t send_n (const void *buf,
+                  size_t len,
+                  int flags,
+                  const ACE_Time_Value *timeout);
+  // Try to send exactly <len> bytes into <buf> from <handle> (uses
+  // the <send> call).  If <send> blocks for longer than <timeout> the
+  // number of bytes actually sent is returned with <errno == ETIME>.
+  // If a timeout does not occur, <send_n> return <len> (i.e., the
+  // number of bytes requested to be sent).
+
+  ssize_t recv_n (void *buf,
+                  size_t len,
+                  int flags,
+                  const ACE_Time_Value *timeout);
+  // Try to recv exactly <len> bytes into <buf> from <handle> (uses
+  // the <ACE::recv_n> call).  The <ACE_Time_Value> indicates how long
+  // to blocking trying to receive.  If <timeout> == 0, the caller
+  // will block until action is possible, else will wait until the
+  // relative time specified in *<timeout> elapses).  If <recv> blocks
+  // for longer than <timeout> the number of bytes actually read is
+  // returned with <errno == ETIME>.  If a timeout does not occur,
+  // <recv_n> return <len> (i.e., the number of bytes requested to be
+  // read).
+
+  ssize_t sendv_n (const iovec iov[],
+                   size_t n) const;
+  // Send an <iovec> of size <n> to the connected socket (uses
+  // <ACE::sendv_n>).  Will block until all bytes are sent or an error
+  // occurs.
+
+  ssize_t recvv_n (iovec iov[],
+                   size_t n) const;
+  // Receive an <iovec> of size <n> to the connected socket.
+*/
+  // = Selectively close endpoints.
+  int close_reader (void);
+  // Close down the reader.
+  int close_writer (void);
+  // Close down the writer.
+
+  int 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).
+
+  // = Meta-type info
+  typedef ACE_Addr PEER_ADDR;
+
+  void dump (void) const;
+  // Dump the state of an object.
+
+  ACE_ALLOC_HOOK_DECLARE;
+  // Declare the dynamic allocation hooks.
+};
+
+#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
+#include "ace/MEM_Stream.i"
+#endif
+
+#endif /* ACE_MEM_STREAM_H */