ACE
6.1.8
|
Receiver side for the record oriented C++ wrapper for UNIX FIFOs. More...
#include <FIFO_Recv_Msg.h>
Public Member Functions | |
ACE_FIFO_Recv_Msg (void) | |
Default constructor. More... | |
ACE_FIFO_Recv_Msg (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 record-oriented 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 record-oriented named pipe for reading. More... | |
ssize_t | recv (ACE_Str_Buf &msg) |
Receive a message based on attributes in an ACE_Str_Buf. More... | |
ssize_t | recv (void *buf, size_t len) |
Receive a message based on buffer pointer and maximum size. More... | |
void | dump (void) const |
Dump the state of an object. More... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. More... | |
![]() | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. More... | |
![]() | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. More... | |
Additional Inherited Members | |
![]() | |
ACE_FIFO (void) | |
Default constructor. More... | |
ACE_FIFO (const ACE_TCHAR *rendezvous, int flags, mode_t perms, LPSECURITY_ATTRIBUTES sa=0) | |
Receiver side for the record oriented C++ wrapper for UNIX FIFOs.
This method works slightly differently on platforms with the ACE_HAS_STREAM_PIPES
configuration setting than those without. With ACE_HAS_STREAM_PIPES, the getmsg()
system function is used and it preserves message boundaries internally. Without ACE_HAS_STREAM_PIPES
, the message boundaries are emulated by this class and ACE_FIFO_Send_Msg cooperating. The sending class first writes an integer number of bytes in the message, then the message. ACE_FIFO_Recv_Msg reads the count, then the data. The operational differences occur primarily when a message is larger than what a caller of this class requests. See recv() for details.
ACE_FIFO_Recv_Msg::ACE_FIFO_Recv_Msg | ( | void | ) |
Default constructor.
ACE_FIFO_Recv_Msg::ACE_FIFO_Recv_Msg | ( | 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 record-oriented named pipe for reading.
void ACE_FIFO_Recv_Msg::dump | ( | void | ) | const |
Dump the state of an object.
int ACE_FIFO_Recv_Msg::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 record-oriented named pipe for reading.
|
inline |
Receive a message based on attributes in an ACE_Str_Buf.
msg | Reference to an ACE_Str_Buf whose buf member points to the memory to receive the data and maxlen member contains the maximum number of bytes to receive. On return after successfully reading data, the len member contains the number of bytes received and placed in the buffer pointed to by msg.buf . |
-1 | Error; consult errno for specific error number. |
ACE_HAS_STREAM_PIPES
configuration setting is defined, the return value is the number of bytes received in the message and will be the same as buf.len
. The return value from the getmsg()
system function is discarded. If ACE_HAS_STREAM_PIPES
is not defined, the number of bytes in the message read from the FIFO is returned. If the message is larger than the maximum length requested in msg.maxlen
, the return value reflects the entire message length, and the msg.len
member reflects how many bytes were actually placed in the caller's buffer. Any part of the message longer than msg.maxlen
is discarded.
|
inline |
Receive a message based on buffer pointer and maximum size.
buf | Pointer to the memory to receive the data. |
len | The maximum number of bytes to receive. |
-1 | Error; consult errno for specific error number. |
ACE_HAS_STREAM_PIPES
configuration setting. With ACE_HAS_STREAM_PIPES
, the return value will be the same asACE_HAS_STREAM_PIPES
, the return value is the total length of the message, including bytes in excess ofACE_FIFO_Recv_Msg::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.