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

#include <SV_Message_Queue.h>

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.
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.

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

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.

{
  ACE_TRACE ("ACE_SV_Message_Queue::ACE_SV_Message_Queue");
}

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.

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

ACE_SV_Message_Queue::~ACE_SV_Message_Queue ( void )

Definition at line 29 of file SV_Message_Queue.cpp.

{
  ACE_TRACE ("ACE_SV_Message_Queue::~ACE_SV_Message_Queue");
}

Member Function Documentation

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.

{
  ACE_TRACE ("ACE_SV_Message_Queue::close");
  this->internal_id_ = -1;
  return 1;
}

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.

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

void ACE_SV_Message_Queue::dump ( void ) const

Dump the state of an object.

Definition at line 17 of file SV_Message_Queue.cpp.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_SV_Message_Queue::dump");
#endif /* ACE_HAS_DUMP */
}

int ACE_SV_Message_Queue::get_id ( void ) const

Get the underly internal id.

Definition at line 47 of file SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_SV_Message_Queue::get_id");
  return this->internal_id_;
}

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.

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

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.

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

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.

{
  ACE_TRACE ("ACE_SV_Message_Queue::remove");
  int result = this->control (IPC_RMID);
  this->internal_id_ = -1;
  return result;
}

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.

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

void ACE_SV_Message_Queue::set_id ( int id )

Set the underly internal id.

Definition at line 54 of file SV_Message_Queue.inl.

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

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.

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

ACE_SV_Message_Queue Class Reference

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation