ACE_SV_Message_Queue Class Reference

Defines the header file for the C++ wrapper for System V IPC message queues. More...

#include <SV_Message_Queue.h>

List of all members.

Public Types

enum  { ACE_CREATE = IPC_CREAT, ACE_OPEN = 0, ACE_NOWAIT = IPC_NOWAIT }

Public Member Functions

 ACE_SV_Message_Queue (void)
 Open a message queue using the <external_id>.
 ACE_SV_Message_Queue (key_t external_id, int create=ACE_SV_Message_Queue::ACE_OPEN, int perms=ACE_DEFAULT_FILE_PERMS)
int open (key_t external_id, int create=ACE_SV_Message_Queue::ACE_OPEN, int perms=ACE_DEFAULT_FILE_PERMS)
 ~ACE_SV_Message_Queue (void)
int close (void)
int remove (void)
 Close down and remove the message queue from the system.
int recv (ACE_SV_Message &mb, int length, long mtype=0, int mflags=0)
int send (const ACE_SV_Message &mb, int length, int mflags=0)
int control (int option, void *arg=0)
 Access the underlying control operations.
int get_id (void) const
 Get the underly internal id.
void set_id (int)
 Set the underly internal id.
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Protected Attributes

int internal_id_
 Returned from the underlying <msgget> system call.


Detailed Description

Defines the header file for the C++ wrapper for System V IPC message queues.


Member Enumeration Documentation

anonymous enum
 

Enumerator:
ACE_CREATE 
ACE_OPEN 
ACE_NOWAIT 


Constructor & Destructor Documentation

ACE_SV_Message_Queue::ACE_SV_Message_Queue void   ) 
 

Open a message queue using the <external_id>.

ACE_SV_Message_Queue::ACE_SV_Message_Queue key_t  external_id,
int  create = ACE_SV_Message_Queue::ACE_OPEN,
int  perms = ACE_DEFAULT_FILE_PERMS
 

ACE_SV_Message_Queue::~ACE_SV_Message_Queue void   ) 
 


Member Function Documentation

ACE_INLINE int ACE_SV_Message_Queue::close void   ) 
 

Close down this instance of the message queue without removing it from the system.

ACE_INLINE int ACE_SV_Message_Queue::control int  option,
void *  arg = 0
 

Access the underlying control operations.

void ACE_SV_Message_Queue::dump void   )  const
 

Dump the state of an object.

ACE_INLINE int ACE_SV_Message_Queue::get_id void   )  const
 

Get the underly internal id.

ACE_INLINE int ACE_SV_Message_Queue::open key_t  external_id,
int  create = ACE_SV_Message_Queue::ACE_OPEN,
int  perms = ACE_DEFAULT_FILE_PERMS
 

ACE_INLINE int ACE_SV_Message_Queue::recv ACE_SV_Message mb,
int  length,
long  mtype = 0,
int  mflags = 0
 

ACE_INLINE int ACE_SV_Message_Queue::remove void   ) 
 

Close down and remove the message queue from the system.

ACE_INLINE int ACE_SV_Message_Queue::send const ACE_SV_Message mb,
int  length,
int  mflags = 0
 

ACE_INLINE void ACE_SV_Message_Queue::set_id int   ) 
 

Set the underly internal id.


Member Data Documentation

ACE_SV_Message_Queue::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

int ACE_SV_Message_Queue::internal_id_ [protected]
 

Returned from the underlying <msgget> system call.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 15:50:47 2005 for ACE by  doxygen 1.4.5