diff options
Diffstat (limited to 'ace/IO_SAP.h')
| -rw-r--r-- | ace/IO_SAP.h | 71 |
1 files changed, 38 insertions, 33 deletions
diff --git a/ace/IO_SAP.h b/ace/IO_SAP.h index f6b0e430a64..4cc1d5cda84 100644 --- a/ace/IO_SAP.h +++ b/ace/IO_SAP.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// IO_SAP.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file IO_SAP.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_IO_SAP_H #define ACE_IO_SAP_H @@ -24,57 +21,65 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_IO_SAP + * + * @brief Defines the methods for the base class of the <ACE_IO_SAP> + * abstraction, which includes <ACE_FILE> and <ACE_DEV>. + */ class ACE_Export ACE_IO_SAP { - // = TITLE - // Defines the methods for the base class of the <ACE_IO_SAP> - // abstraction, which includes <ACE_FILE> and <ACE_DEV>. public: enum { - INVALID_HANDLE = -1 // Be consistent with Winsock + /// Be consistent with Winsock + INVALID_HANDLE = -1 }; + /// Default dtor. ~ACE_IO_SAP (void); - // Default dtor. + /// Interface for ioctl. int control (int cmd, void *) const; - // Interface for ioctl. // = Common I/O handle options related to files. + /** + * Enable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), + * non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), + * which is passed as the <value>. + */ int enable (int value) const; - // Enable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), - // non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), - // which is passed as the <value>. + /** + * Disable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), + * non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), + * which is passed as the <value>. + */ int disable (int value) const; - // Disable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), - // non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), - // which is passed as the <value>. + /// Get the underlying handle. ACE_HANDLE get_handle (void) const; - // Get the underlying handle. + /// Set the underlying handle. void set_handle (ACE_HANDLE handle); - // Set the underlying handle. + /// Dump the state of an object. void dump (void) const; - // Dump the state of an object. + /// Declare the dynamic allocation hooks. ACE_ALLOC_HOOK_DECLARE; - // Declare the dynamic allocation hooks. protected: + /// Ensure that ACE_IO_SAP is an abstract base class. ACE_IO_SAP (void); - // Ensure that ACE_IO_SAP is an abstract base class. private: + /// Underlying I/O handle. ACE_HANDLE handle_; - // Underlying I/O handle. + /// Cache the process ID. static pid_t pid_; - // Cache the process ID. }; #if !defined (ACE_LACKS_INLINE_FUNCTIONS) |