ACE_Typed_SV_Message_Queue< T > Class Template Reference

Defines the header file for the C++ wrapper facade for typed message queues. More...

#include <Typed_SV_Message_Queue.h>

Collaboration diagram for ACE_Typed_SV_Message_Queue< T >:

List of all members.

Public Types
enum	{ ACE_CREATE = IPC_CREAT, ACE_OPEN = 0, ACE_NOWAIT = IPC_NOWAIT }
Public Member Functions
	ACE_Typed_SV_Message_Queue (void)
	ACE_Typed_SV_Message_Queue (key_t external_id, int create=ACE_OPEN, int perms=ACE_DEFAULT_FILE_PERMS)
int	open (key_t external_id, int create=ACE_OPEN, int perms=ACE_DEFAULT_FILE_PERMS)
int	close (void)
int	remove (void)
	~ACE_Typed_SV_Message_Queue (void)
int	send (const ACE_Typed_SV_Message< T > &mb, int mflags=0)
	Send method.
int	recv (ACE_Typed_SV_Message< T > &mb, int mflags=0)
	Recv method.
int	get_id (void) const
	Return the id of the underlying ACE_SV_Message_Queue.
int	control (int option, void *arg=0)
	Control the underlying message queue.
void	dump (void) const
	Dump the state of an object.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Private Attributes
ACE_SV_Message_Queue	message_queue_

---

Detailed Description

template<class T>
class ACE_Typed_SV_Message_Queue< T >

Defines the header file for the C++ wrapper facade for typed message queues.

Definition at line 33 of file Typed_SV_Message_Queue.h.

---

Member Enumeration Documentation

template<class T >

anonymous enum

Enumerator:

ACE_CREATE
ACE_OPEN
ACE_NOWAIT

Definition at line 36 of file Typed_SV_Message_Queue.h.

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

---

Constructor & Destructor Documentation

template<class T >

ACE_Typed_SV_Message_Queue< T >::ACE_Typed_SV_Message_Queue

(

void

)

Definition at line 32 of file Typed_SV_Message_Queue.cpp.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::ACE_Typed_SV_Message_Queue");
}

template<class T >

ACE_Typed_SV_Message_Queue< T >::ACE_Typed_SV_Message_Queue	(	key_t	external_id,
		int	create = ACE_OPEN,
		int	perms = ACE_DEFAULT_FILE_PERMS
	)

Definition at line 38 of file Typed_SV_Message_Queue.cpp.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::ACE_Typed_SV_Message_Queue");
  if (this->open (external_id, create, perms) == -1)
    ACE_ERROR ((LM_ERROR,
                "ACE_Typed_SV_Message_Queue::ACE_Typed_SV_Message_Queue"));
}

template<class T >

ACE_Typed_SV_Message_Queue< T >::~ACE_Typed_SV_Message_Queue

(

void

)

Definition at line 49 of file Typed_SV_Message_Queue.cpp.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::~ACE_Typed_SV_Message_Queue");
}

---

Member Function Documentation

template<class T >

int ACE_Typed_SV_Message_Queue< T >::close

(

void

)

Definition at line 21 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::close");
  return 1;
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::control	(	int	option,
		void *	arg = 0
	)

Control the underlying message queue.

Definition at line 66 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::control");

  return this->message_queue_.control (option, arg);
}

template<class T >

void ACE_Typed_SV_Message_Queue< T >::dump

(

void

)

const

Dump the state of an object.

Definition at line 24 of file Typed_SV_Message_Queue.cpp.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::dump");
#endif /* ACE_HAS_DUMP */
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::get_id

(

void

)

const

Return the id of the underlying ACE_SV_Message_Queue.

Definition at line 75 of file Typed_SV_Message_Queue.inl.

{
  return this->message_queue_.get_id ();
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::open	(	key_t	external_id,
		int	create = ACE_OPEN,
		int	perms = ACE_DEFAULT_FILE_PERMS
	)

Definition at line 10 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::open");
  return this->message_queue_.open (external_id, create, perms);
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::recv	(	ACE_Typed_SV_Message< T > &	mb,
		int	mflags = 0
	)

Recv method.

Definition at line 28 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::recv");

  int length =
    this->message_queue_.recv (reinterpret_cast<ACE_SV_Message &> (mb),
                               mb.max_size (),
                               mb.type (),
                               mflags);
  if (length != -1)
    mb.length (length);

  return length;
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::remove

(

void

)

Definition at line 58 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::remove");

  return this->message_queue_.remove ();
}

template<class T >

int ACE_Typed_SV_Message_Queue< T >::send	(	const ACE_Typed_SV_Message< T > &	mb,
		int	mflags = 0
	)

Send method.

Definition at line 45 of file Typed_SV_Message_Queue.inl.

{
  ACE_TRACE ("ACE_Typed_SV_Message_Queue<T>::send");
  return
    this->message_queue_.send (
      reinterpret_cast<ACE_SV_Message &> (
        const_cast<ACE_Typed_SV_Message<T> &> (mb)),
      mb.length (),
      mflags);
}

---

Member Data Documentation

template<class T >

ACE_Typed_SV_Message_Queue< T >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 71 of file Typed_SV_Message_Queue.h.

template<class T >

ACE_SV_Message_Queue ACE_Typed_SV_Message_Queue< T >::message_queue_ [private]

Definition at line 74 of file Typed_SV_Message_Queue.h.

---

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

• Typed_SV_Message_Queue.h
• Typed_SV_Message_Queue.cpp
• Typed_SV_Message_Queue.inl