summaryrefslogtreecommitdiff
path: root/ace/Pipe.h
diff options
context:
space:
mode:
Diffstat (limited to 'ace/Pipe.h')
-rw-r--r--ace/Pipe.h73
1 files changed, 38 insertions, 35 deletions
diff --git a/ace/Pipe.h b/ace/Pipe.h
index 7fe3a772d04..d58767b1729 100644
--- a/ace/Pipe.h
+++ b/ace/Pipe.h
@@ -1,18 +1,15 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// Pipe.h
-//
-// = AUTHOR
-// Doug Schmidt
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Pipe.h
+ *
+ * $Id$
+ *
+ * @author Doug Schmidt
+ */
+//=============================================================================
+
#ifndef ACE_PIPE_H
#define ACE_PIPE_H
@@ -24,52 +21,58 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ACE_Pipe
+ *
+ * @brief Provides a bidirectional "pipe" abstraction that is portable
+ * to Windows NT, SVR4 UNIX, and BSD UNIX.
+ *
+ * Uses "name" for lookup in the ACE service repository. Obtains
+ * the object and returns it as the appropriate type.
+ */
class ACE_Export ACE_Pipe
{
- // = TITLE
- // Provides a bidirectional "pipe" abstraction that is portable
- // to Windows NT, SVR4 UNIX, and BSD UNIX.
- //
- // = DESCRIPTION
- // Uses "name" for lookup in the ACE service repository. Obtains
- // the object and returns it as the appropriate type.
public:
// = Initialization and termination.
+ /// Default constructor (does nothing...).
ACE_Pipe (void);
- // Default constructor (does nothing...).
+ /// Open the pipe and initialize the handles.
ACE_Pipe (ACE_HANDLE handles[2]);
- // Open the pipe and initialize the handles.
+ /// Initialize the <ACE_Pipe> from the <read> and <write> handles.
ACE_Pipe (ACE_HANDLE read, ACE_HANDLE write);
- // Initialize the <ACE_Pipe> from the <read> and <write> handles.
+ /// Default dtor. It doesn't close the handles for you.
~ACE_Pipe (void);
- // Default dtor. It doesn't close the handles for you.
+ /// Open the pipe and initialize the handles.
int open (ACE_HANDLE handles[2]);
- // Open the pipe and initialize the handles.
+ /// Open the pipe, setting the buffer size to the maximum.
int open (int buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ);
- // Open the pipe, setting the buffer size to the maximum.
+ /// Close down the pipe HANDLEs;
int close (void);
- // Close down the pipe HANDLEs;
// = Accessors.
+ /**
+ * This is the "read" side of the pipe. Note, however, that
+ * processes can also write to this handle as well since pipes are
+ * bi-directional.
+ */
ACE_HANDLE read_handle (void) const;
- // This is the "read" side of the pipe. Note, however, that
- // processes can also write to this handle as well since pipes are
- // bi-directional.
+ /**
+ * This is the "write" side of the pipe. Note, however, that
+ * processes can also read to this handle as well since pipes are
+ * bi-directional.
+ */
ACE_HANDLE write_handle (void) const;
- // This is the "write" side of the pipe. Note, however, that
- // processes can also read to this handle as well since pipes are
- // bi-directional.
+ /// Dump the state of the object.
void dump (void) const;
- // Dump the state of the object.
private:
ACE_HANDLE handles_[2];