ACE_FIFO Class Reference

Abstract base class for UNIX FIFOs. More...

#include <FIFO.h>

Inheritance diagram for ACE_FIFO:

Collaboration diagram for ACE_FIFO:

Public Member Functions
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_IPC_SAP
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

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

Private Attributes
ACE_TCHAR	rendezvous_ [MAXPATHLEN+1]
	Rendezvous point in the file system. More...

Detailed Description

Abstract base class for UNIX FIFOs.

UNIX FIFOs are also known Named Pipes, which are totally unrelated to Windows Named Pipes. If you want to use a local IPC mechanism that will be portable to both UNIX and Windows, take a look at the ACE_Pipe or ACE_SPIPE_Stream classes.

Constructor & Destructor Documentation

ACE_FIFO::ACE_FIFO ( void  )

protected

Default constructor.

Protected constructors ensure this class cannot be used directly. User code must use ACE_FIFO_Send and/or ACE_FIFO_Recv.

ACE_FIFO::ACE_FIFO ( const ACE_TCHAR *  rendezvous, int  flags, mode_t  perms, LPSECURITY_ATTRIBUTES  sa = 0  )

protected

Open up the named pipe on the rendezvous in accordance with the flags.

Member Function Documentation

int ACE_FIFO::close

(

void

)

Close down the ACE_FIFO without removing the rendezvous point.

void ACE_FIFO::dump

(

void

)

const

Dump the state of an object.

int ACE_FIFO::get_local_addr ( const ACE_TCHAR *&  rendezvous ) const

inline

Return the local address of this endpoint.

int ACE_FIFO::open	(	const ACE_TCHAR *	rendezvous,
		int	flags,
		mode_t	perms,
		LPSECURITY_ATTRIBUTES	sa = 0
	)

Open up the named pipe (FIFO) on the rendezvous point in accordance with the flags.

If flags contains O_CREAT open() will attempt to call mkfifo() to create the FIFO before opening it. In this case, this method will not fail simply because the fifo already exists.

Return values

0	for success
-1	for error; errno contains the error code.

int ACE_FIFO::remove ( void  )

inline

Close down the ACE_FIFO and remove the rendezvous point from the file system.

Member Data Documentation

ACE_FIFO::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_TCHAR ACE_FIFO::rendezvous_[MAXPATHLEN+1]

private

Rendezvous point in the file system.

---

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

• FIFO.h
• FIFO.cpp
• FIFO.inl