ACE  6.1.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
ACE_FIFO_Recv Class Reference

Receiver side of the bytestream C++ wrapper for UNIX FIFOs. More...

#include <FIFO_Recv.h>

Inheritance diagram for ACE_FIFO_Recv:
Inheritance graph
[legend]
Collaboration diagram for ACE_FIFO_Recv:
Collaboration graph
[legend]

Public Member Functions

int close (void)
 Close down the fifo. More...
 
ssize_t recv (void *buf, size_t len)
 Recv buf of up to len bytes. More...
 
ssize_t recv_n (void *buf, size_t len)
 Recv buf of exactly len bytes (block until done). More...
 
void dump (void) const
 Dump the state of an object. More...
 
Initialization methods.

Note that ACE_NONBLOCK will be added to any flags value passed. This causes the open to succeed even if no writer has yet opened the fifo. There is no way to disable this behavior.

  • persistent Means "open fifo for writing, as well as reading." This ensures that the fifo never gets EOF, even if there aren't any writers at the moment!
 ACE_FIFO_Recv (void)
 Default constructor. More...
 
 ACE_FIFO_Recv (const ACE_TCHAR *rendezvous, int flags=O_CREAT|O_RDONLY, mode_t perms=ACE_DEFAULT_FILE_PERMS, int persistent=1, LPSECURITY_ATTRIBUTES sa=0)
 Open up a bytestream named pipe for reading. More...
 
int open (const ACE_TCHAR *rendezvous, int flags=O_CREAT|O_RDONLY, mode_t perms=ACE_DEFAULT_FILE_PERMS, int persistent=1, LPSECURITY_ATTRIBUTES sa=0)
 Open up a bytestream named pipe for reading. More...
 
- Public Member Functions inherited from ACE_FIFO
int open (const ACE_TCHAR *rendezvous, int flags, mode_t perms, LPSECURITY_ATTRIBUTES sa=0)
 
int close (void)
 Close down the ACE_FIFO without removing the rendezvous point. More...
 
int remove (void)
 
int get_local_addr (const ACE_TCHAR *&rendezvous) const
 Return the local address of this endpoint. More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_IPC_SAP
int control (int cmd, void *) const
 Interface for <ioctl>. More...
 
int enable (int value) const
 
int disable (int value) const
 
ACE_HANDLE get_handle (void) const
 Get the underlying handle. More...
 
void set_handle (ACE_HANDLE handle)
 Set the underlying handle. More...
 
void dump (void) const
 Dump the state of an object. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_FIFO
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_IPC_SAP
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Attributes

ACE_HANDLE aux_handle_
 Auxiliary handle that is used to implement persistent FIFOs. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ACE_FIFO
 ACE_FIFO (void)
 Default constructor. More...
 
 ACE_FIFO (const ACE_TCHAR *rendezvous, int flags, mode_t perms, LPSECURITY_ATTRIBUTES sa=0)
 

Detailed Description

Receiver side of the bytestream C++ wrapper for UNIX FIFOs.

Constructor & Destructor Documentation

ACE_FIFO_Recv::ACE_FIFO_Recv ( void  )

Default constructor.

ACE_FIFO_Recv::ACE_FIFO_Recv ( const ACE_TCHAR rendezvous,
int  flags = O_CREAT | O_RDONLY,
mode_t  perms = ACE_DEFAULT_FILE_PERMS,
int  persistent = 1,
LPSECURITY_ATTRIBUTES  sa = 0 
)

Open up a bytestream named pipe for reading.

Member Function Documentation

int ACE_FIFO_Recv::close ( void  )

Close down the fifo.

void ACE_FIFO_Recv::dump ( void  ) const

Dump the state of an object.

int ACE_FIFO_Recv::open ( const ACE_TCHAR rendezvous,
int  flags = O_CREAT | O_RDONLY,
mode_t  perms = ACE_DEFAULT_FILE_PERMS,
int  persistent = 1,
LPSECURITY_ATTRIBUTES  sa = 0 
)

Open up a bytestream named pipe for reading.

ssize_t ACE_FIFO_Recv::recv ( void *  buf,
size_t  len 
)
inline

Recv buf of up to len bytes.

ssize_t ACE_FIFO_Recv::recv_n ( void *  buf,
size_t  len 
)
inline

Recv buf of exactly len bytes (block until done).

Member Data Documentation

ACE_FIFO_Recv::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_HANDLE ACE_FIFO_Recv::aux_handle_
private

Auxiliary handle that is used to implement persistent FIFOs.


The documentation for this class was generated from the following files: