summaryrefslogtreecommitdiff
path: root/ace/FIFO_Send.h
diff options
context:
space:
mode:
authorcoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-11-01 22:17:39 +0000
committercoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>2000-11-01 22:17:39 +0000
commit53284e215e3d3351a7d7e9c4b68f14b427fb4377 (patch)
tree97236ece363cff48fd287c780db4290da39b02cb /ace/FIFO_Send.h
parent7b7c52ad2abd228138ba1a948d5e28bf6dc3b880 (diff)
downloadATCD-53284e215e3d3351a7d7e9c4b68f14b427fb4377.tar.gz
ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>
Diffstat (limited to 'ace/FIFO_Send.h')
-rw-r--r--ace/FIFO_Send.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/ace/FIFO_Send.h b/ace/FIFO_Send.h
index a9733f8d478..7c870454b82 100644
--- a/ace/FIFO_Send.h
+++ b/ace/FIFO_Send.h
@@ -1,18 +1,15 @@
/* -*- C++ -*- */
-// $Id$
-// ============================================================================
-//
-// = LIBRARY
-// ace
-//
-// = FILENAME
-// FIFO_Send.h
-//
-// = AUTHOR
-// Doug Schmidt
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file FIFO_Send.h
+ *
+ * $Id$
+ *
+ * @author Doug Schmidt
+ */
+//=============================================================================
+
#ifndef ACE_FIFO_SEND_H
#define ACE_FIFO_SEND_H
@@ -24,38 +21,41 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class ACE_FIFO_Send
+ *
+ * @brief Sender side for the bytestream C++ wrapper for UNIX FIFOs
+ */
class ACE_Export ACE_FIFO_Send : public ACE_FIFO
{
- // = TITLE
- // Sender side for the bytestream C++ wrapper for UNIX FIFOs
public:
// = Initialization methods.
+ /// Default constructor.
ACE_FIFO_Send (void);
- // Default constructor.
+ /// Open up a bytestream named pipe for writing.
ACE_FIFO_Send (const ACE_TCHAR *rendezvous,
int flags = O_WRONLY,
int perms = ACE_DEFAULT_FILE_PERMS,
LPSECURITY_ATTRIBUTES sa = 0);
- // Open up a bytestream named pipe for writing.
+ /// Open up a bytestream named pipe for writing.
int open (const ACE_TCHAR *rendezvous,
int flags = O_WRONLY,
int perms = ACE_DEFAULT_FILE_PERMS,
LPSECURITY_ATTRIBUTES sa = 0);
- // Open up a bytestream named pipe for writing.
+ /// Send <buf> of up to <len> bytes.
ssize_t send (const void *buf, size_t len);
- // Send <buf> of up to <len> bytes.
+ /// Send <buf> of exactly <len> bytes (block until done).
ssize_t send_n (const void *buf, size_t len);
- // Send <buf> of exactly <len> bytes (block until done).
+ /// 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)