diff options
Diffstat (limited to 'ace/FIFO_Recv_Msg.h')
| -rw-r--r-- | ace/FIFO_Recv_Msg.h | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/ace/FIFO_Recv_Msg.h b/ace/FIFO_Recv_Msg.h index 4cc19ff2675..3920e063630 100644 --- a/ace/FIFO_Recv_Msg.h +++ b/ace/FIFO_Recv_Msg.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// FIFO_Recv_Msg.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file FIFO_Recv_Msg.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_FIFO_RECV_MSG_H #define ACE_FIFO_RECV_MSG_H @@ -24,53 +21,56 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_FIFO_Recv_Msg + * + * @brief Receiver side for the record oriented C++ wrapper for UNIX FIFOs. + */ class ACE_Export ACE_FIFO_Recv_Msg : public ACE_FIFO_Recv { - // = TITLE - // Receiver side for the record oriented C++ wrapper for UNIX FIFOs. public: // = Initialization methods. + /// Default constructor. ACE_FIFO_Recv_Msg (void); - // Default constructor. + /// Open up a record-oriented named pipe for reading. ACE_FIFO_Recv_Msg (const ACE_TCHAR *rendezvous, int flags = O_CREAT | O_RDONLY, int perms = ACE_DEFAULT_FILE_PERMS, int persistent = 1, LPSECURITY_ATTRIBUTES sa = 0); - // Open up a record-oriented named pipe for reading. + /// Open up a record-oriented named pipe for reading. int open (const ACE_TCHAR *rendezvous, int flags = O_CREAT | O_RDONLY, int perms = ACE_DEFAULT_FILE_PERMS, int persistent = 1, LPSECURITY_ATTRIBUTES sa = 0); - // Open up a record-oriented named pipe for reading. + /// Recv <msg> as an ACE_Str_Buf. ssize_t recv (ACE_Str_Buf &msg); - // Recv <msg> as an ACE_Str_Buf. + /// Recv <msg> as a buffer. ssize_t recv (void *buf, size_t len); - // Recv <msg> as a buffer. #if defined (ACE_HAS_STREAM_PIPES) + /// Recv <data> and <cntl> message via Stream pipes. ssize_t recv (ACE_Str_Buf *data, ACE_Str_Buf *cntl, int *flags); - // Recv <data> and <cntl> message via Stream pipes. + /// Recv <data> and <cntl> message via Stream pipes in "band" mode. ssize_t recv (int *band, ACE_Str_Buf *data, ACE_Str_Buf *cntl, int *flags); - // Recv <data> and <cntl> message via Stream pipes in "band" mode. #endif /* ACE_HAS_STREAM_PIPES */ + /// 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. }; #if !defined (ACE_LACKS_INLINE_FUNCTIONS) |