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

 ACE_CREATE = IPC_CREAT
 ACE_OPEN = 0
 ACE_NOWAIT = IPC_NOWAIT
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.
ssize_t 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.

Definition at line 37 of file SV_Message_Queue.h.

Member Enumeration Documentation

anonymous enum

Enumerator:
ACE_CREATE 
ACE_OPEN 
ACE_NOWAIT 

Definition at line 41 of file SV_Message_Queue.h.

00042   {
00043     ACE_CREATE = IPC_CREAT,
00044     ACE_OPEN   = 0,
00045     ACE_NOWAIT = IPC_NOWAIT
00046   };

Constructor & Destructor Documentation

ACE_SV_Message_Queue::ACE_SV_Message_Queue ( void   ) 

Open a message queue using the <external_id>.

Definition at line 24 of file SV_Message_Queue.cpp.

References ACE_TRACE.

00025 {
00026   ACE_TRACE ("ACE_SV_Message_Queue::ACE_SV_Message_Queue");
00027 }

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 
)

Definition at line 34 of file SV_Message_Queue.cpp.

References ACE_ERROR, ACE_TEXT, ACE_TRACE, and LM_ERROR.

00037 {
00038   ACE_TRACE ("ACE_SV_Message_Queue::ACE_SV_Message_Queue");
00039   if (this->open (external_id, create, perms) == -1)
00040     ACE_ERROR ((LM_ERROR, ACE_TEXT ("%p\n"),
00041                 ACE_TEXT ("ACE_SV_Message_Queue::ACE_SV_Message_Queue")));
00042 }

ACE_SV_Message_Queue::~ACE_SV_Message_Queue ( void   ) 

Definition at line 29 of file SV_Message_Queue.cpp.

References ACE_TRACE.

00030 {
00031   ACE_TRACE ("ACE_SV_Message_Queue::~ACE_SV_Message_Queue");
00032 }

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.

Definition at line 22 of file SV_Message_Queue.inl.

References ACE_TRACE, and internal_id_.

00023 {
00024   ACE_TRACE ("ACE_SV_Message_Queue::close");
00025   this->internal_id_ = -1;
00026   return 1;
00027 }

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

Access the underlying control operations.

Definition at line 30 of file SV_Message_Queue.inl.

References ACE_TRACE, and ACE_OS::msgctl().

Referenced by ACE_Typed_SV_Message_Queue< T >::control(), and remove().

00031 {
00032   ACE_TRACE ("ACE_SV_Message_Queue::control");
00033   return ACE_OS::msgctl (this->internal_id_, option,
00034                          (struct msqid_ds *) arg);
00035 }

ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_SV_Message_Queue::dump ( void   )  const

Dump the state of an object.

Definition at line 17 of file SV_Message_Queue.cpp.

References ACE_TRACE.

00018 {
00019 #if defined (ACE_HAS_DUMP)
00020   ACE_TRACE ("ACE_SV_Message_Queue::dump");
00021 #endif /* ACE_HAS_DUMP */
00022 }

ACE_INLINE int ACE_SV_Message_Queue::get_id ( void   )  const

Get the underly internal id.

Definition at line 47 of file SV_Message_Queue.inl.

References ACE_TRACE, and internal_id_.

Referenced by ACE_Typed_SV_Message_Queue< T >::get_id().

00048 {
00049   ACE_TRACE ("ACE_SV_Message_Queue::get_id");
00050   return this->internal_id_;
00051 }

ACE_BEGIN_VERSIONED_NAMESPACE_DECL 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 
)

Definition at line 13 of file SV_Message_Queue.inl.

References ACE_TRACE, internal_id_, and ACE_OS::msgget().

Referenced by ACE_Typed_SV_Message_Queue< T >::open().

00014 {
00015   ACE_TRACE ("ACE_SV_Message_Queue::open");
00016   return this->internal_id_ = ACE_OS::msgget (external_id, create | perms);
00017 }

ACE_INLINE ssize_t ACE_SV_Message_Queue::recv ( ACE_SV_Message &  mb,
int  length,
long  mtype = 0,
int  mflags = 0 
)

Definition at line 61 of file SV_Message_Queue.inl.

References ACE_TRACE, and ACE_OS::msgrcv().

Referenced by ACE_Typed_SV_Message_Queue< T >::recv().

00065 {
00066   ACE_TRACE ("ACE_SV_Message_Queue::recv");
00067   return ACE_OS::msgrcv (this->internal_id_, (void *) &mb,
00068                          length, type, mflags);
00069 }

ACE_INLINE int ACE_SV_Message_Queue::remove ( void   ) 

Close down and remove the message queue from the system.

Definition at line 38 of file SV_Message_Queue.inl.

References ACE_TRACE, control(), internal_id_, and IPC_RMID.

Referenced by ACE_Typed_SV_Message_Queue< T >::remove().

00039 {
00040   ACE_TRACE ("ACE_SV_Message_Queue::remove");
00041   int result = this->control (IPC_RMID);
00042   this->internal_id_ = -1;
00043   return result;
00044 }

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

Definition at line 72 of file SV_Message_Queue.inl.

References ACE_TRACE, and ACE_OS::msgsnd().

Referenced by ACE_Typed_SV_Message_Queue< T >::send().

00075 {
00076   ACE_TRACE ("ACE_SV_Message_Queue::send");
00077   return ACE_OS::msgsnd (this->internal_id_, (void *) &mb,
00078                          length, mflags);
00079 }

ACE_INLINE void ACE_SV_Message_Queue::set_id ( int   ) 

Set the underly internal id.

Definition at line 54 of file SV_Message_Queue.inl.

References ACE_TRACE, and internal_id_.

00055 {
00056   ACE_TRACE ("ACE_SV_Message_Queue::set_id");
00057   this->internal_id_ = id;
00058 }

Member Data Documentation

ACE_SV_Message_Queue::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 90 of file SV_Message_Queue.h.

int ACE_SV_Message_Queue::internal_id_ [protected]

Returned from the underlying <msgget> system call.

Definition at line 94 of file SV_Message_Queue.h.

Referenced by close(), get_id(), open(), remove(), and set_id().

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:35:42 2010 for ACE by  doxygen 1.4.7