ACE_Message_Queue_NT Class Reference

Message Queue implementation using IO completion port on NT. More...

#include <Message_Queue_NT.h>

Inheritance diagram for ACE_Message_Queue_NT:

Collaboration diagram for ACE_Message_Queue_NT:

Public Member Functions
	ACE_Message_Queue_NT (DWORD max_threads=ACE_Message_Queue_Base::DEFAULT_HWM)
virtual int	open (DWORD max_threads=ACE_Message_Queue_Base::DEFAULT_HWM)
virtual int	close ()
virtual	~ACE_Message_Queue_NT ()
	Close down the message queue and release all resources.
virtual int	enqueue_tail (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0)
virtual int	enqueue (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0)
virtual int	dequeue_head (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0)
virtual int	dequeue (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0)
virtual bool	is_full ()
virtual bool	is_empty ()
virtual size_t	message_bytes ()
virtual size_t	message_length ()
virtual size_t	message_count ()
virtual void	message_bytes (size_t new_size)
virtual void	message_length (size_t new_length)
virtual DWORD	max_threads ()
	Get the max concurrent thread number.
virtual int	deactivate ()
virtual int	activate ()
virtual int	pulse ()
virtual int	deactivated ()
int	peek_dequeue_head (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0)
ACE_Notification_Strategy *	notification_strategy ()
	Get the notification strategy for the Message_Queue.
void	notification_strategy (ACE_Notification_Strategy *s)
	Set the notification strategy for the Message_Queue.
virtual void	dump () const
	Dump the state of an object.
virtual ACE_HANDLE	completion_port ()
	Get the handle to the underlying completion port.
Public Member Functions inherited from ACE_Message_Queue_Base
	ACE_Message_Queue_Base ()
virtual	~ACE_Message_Queue_Base ()
	Close down the message queue and release all resources.
virtual int	state ()
	Returns the current state of the queue.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Private Member Functions
	ACE_Message_Queue_NT (const ACE_Message_Queue_NT &)=delete
void	operator= (const ACE_Message_Queue_NT &)=delete
	ACE_Message_Queue_NT (ACE_Message_Queue_NT &&)=delete
void	operator= (ACE_Message_Queue_NT &&)=delete

Private Attributes
DWORD	max_cthrs_
	Maximum threads that can be released (and run) concurrently.
DWORD	cur_thrs_
	Current number of threads waiting to dequeue messages.
size_t	cur_bytes_
	Current number of bytes in queue.
size_t	cur_length_
	Current length of messages in queue.
size_t	cur_count_
	Current number of messages in the queue.
ACE_SYNCH_MUTEX	lock_
ACE_HANDLE	completion_port_
	Underlying NT IoCompletionPort.

Additional Inherited Members
Public Types inherited from ACE_Message_Queue_Base
enum	{   DEFAULT_HWM = 16 * 1024 , DEFAULT_LWM = 16 * 1024 , ACTIVATED = 1 , DEACTIVATED = 2 ,   PULSED = 3 }
Protected Attributes inherited from ACE_Message_Queue_Base
int	state_

Detailed Description

Message Queue implementation using IO completion port on NT.

Implementation of a strip-downed ACE_Message_Queue using NT's IO completion port mechanism.

Note

Many ACE_Message_Queue features are not supported with this implementation, including:

• <open> method have different signatures.
• <dequeue_head> requires that the ACE_Message_Block pointer argument point to an ACE_Message_Block that was allocated by the caller.
• <peek_dequeue_head>.
• <ACE_Message_Queue_Iterators>.
• No flow control.

Constructor & Destructor Documentation

ACE_Message_Queue_NT() [1/3]

ACE_Message_Queue_NT::ACE_Message_Queue_NT

(

DWORD

max_threads = ACE_Message_Queue_Base::DEFAULT_HWM

)

~ACE_Message_Queue_NT()

ACE_Message_Queue_NT::~ACE_Message_Queue_NT ( )

virtual

Close down the message queue and release all resources.

ACE_Message_Queue_NT() [2/3]

ACE_Message_Queue_NT::ACE_Message_Queue_NT ( const ACE_Message_Queue_NT & )

privatedelete

ACE_Message_Queue_NT() [3/3]

ACE_Message_Queue_NT::ACE_Message_Queue_NT ( ACE_Message_Queue_NT && )

privatedelete

Member Function Documentation

activate()

int ACE_Message_Queue_NT::activate ( )

virtual

Reactivate the queue so that threads can enqueue and dequeue messages again. Returns the state of the queue before the call.

Implements ACE_Message_Queue_Base.

close()

int ACE_Message_Queue_NT::close ( )

virtual

Close down the underlying I/O completion port. You need to re-open the MQ after this function is executed.

Implements ACE_Message_Queue_Base.

completion_port()

ACE_HANDLE ACE_Message_Queue_NT::completion_port ( )

inlinevirtual

Get the handle to the underlying completion port.

deactivate()

int ACE_Message_Queue_NT::deactivate ( )

virtual

Deactivate the queue and wake up all threads waiting on the queue so they can continue. No messages are removed from the queue, however. Any other operations called until the queue is activated again will immediately return -1 with errno ESHUTDOWN.

Return values

The	queue's state before this call.

Implements ACE_Message_Queue_Base.

deactivated()

int ACE_Message_Queue_NT::deactivated ( )

inlinevirtual

Returns true if the state of the queue is <DEACTIVATED>, but false if the queue's is <ACTIVATED> or <PULSED>.

Implements ACE_Message_Queue_Base.

dequeue()

int ACE_Message_Queue_NT::dequeue ( ACE_Message_Block *& first_item, ACE_Time_Value * timeout = 0 )

virtual

Implements ACE_Message_Queue_Base.

dequeue_head()

int ACE_Message_Queue_NT::dequeue_head ( ACE_Message_Block *& first_item, ACE_Time_Value * timeout = 0 )

inlinevirtual

Dequeue and return the ACE_Message_Block * at the head of the queue. Returns -1 on failure, else the number of items still on the queue.

Implements ACE_Message_Queue_Base.

dump()

void ACE_Message_Queue_NT::dump ( ) const

virtual

Dump the state of an object.

Implements ACE_Message_Queue_Base.

enqueue()

int ACE_Message_Queue_NT::enqueue ( ACE_Message_Block * new_item, ACE_Time_Value * timeout = 0 )

virtual

Implements ACE_Message_Queue_Base.

enqueue_tail()

int ACE_Message_Queue_NT::enqueue_tail ( ACE_Message_Block * new_item, ACE_Time_Value * timeout = 0 )

inlinevirtual

Enqueue an ACE_Message_Block * at the end of the queue. Returns -1 on failure, else the number of items still on the queue.

Implements ACE_Message_Queue_Base.

is_empty()

bool ACE_Message_Queue_NT::is_empty ( )

inlinevirtual

True if queue is empty, else false. Notice the return value is only transient.

Implements ACE_Message_Queue_Base.

is_full()

bool ACE_Message_Queue_NT::is_full ( )

inlinevirtual

Always return false.

Implements ACE_Message_Queue_Base.

max_threads()

DWORD ACE_Message_Queue_NT::max_threads ( )

inlinevirtual

Get the max concurrent thread number.

message_bytes() [1/2]

size_t ACE_Message_Queue_NT::message_bytes ( )

inlinevirtual

Number of total bytes on the queue, i.e., sum of the message block sizes.

Implements ACE_Message_Queue_Base.

message_bytes() [2/2]

void ACE_Message_Queue_NT::message_bytes ( size_t new_size )

inlinevirtual

New value of the number of total bytes on the queue, i.e., sum of the message block sizes.

Implements ACE_Message_Queue_Base.

message_count()

size_t ACE_Message_Queue_NT::message_count ( )

inlinevirtual

Number of total messages on the queue.

Implements ACE_Message_Queue_Base.

message_length() [1/2]

size_t ACE_Message_Queue_NT::message_length ( )

inlinevirtual

Number of total length on the queue, i.e., sum of the message block lengths.

Implements ACE_Message_Queue_Base.

message_length() [2/2]

void ACE_Message_Queue_NT::message_length ( size_t new_length )

inlinevirtual

New value of the number of total length on the queue, i.e., sum of the message block lengths.

Implements ACE_Message_Queue_Base.

notification_strategy() [1/2]

ACE_Notification_Strategy * ACE_Message_Queue_NT::notification_strategy ( )

inlinevirtual

Get the notification strategy for the Message_Queue.

Implements ACE_Message_Queue_Base.

notification_strategy() [2/2]

void ACE_Message_Queue_NT::notification_strategy ( ACE_Notification_Strategy * s )

inlinevirtual

Set the notification strategy for the Message_Queue.

Implements ACE_Message_Queue_Base.

open()

int ACE_Message_Queue_NT::open ( DWORD max_threads = ACE_Message_Queue_Base::DEFAULT_HWM )

virtual

Initialize the Message Queue by creating a new NT I/O completion port. The first arguemnt specifies the number of threads released by the MQ that are allowed to run concurrently. Return 0 when succeeds, -1 otherwise.

operator=() [1/2]

void ACE_Message_Queue_NT::operator= ( ACE_Message_Queue_NT && )

privatedelete

operator=() [2/2]

void ACE_Message_Queue_NT::operator= ( const ACE_Message_Queue_NT & )

privatedelete

peek_dequeue_head()

int ACE_Message_Queue_NT::peek_dequeue_head ( ACE_Message_Block *& first_item, ACE_Time_Value * timeout = 0 )

inlinevirtual

Retrieve the first ACE_Message_Block without removing it. Note that timeout uses <{absolute}> time rather than <{relative}> time. If the timeout elapses without receiving a message -1 is returned and errno is set to EWOULDBLOCK. If the queue is deactivated -1 is returned and errno is set to ESHUTDOWN. Otherwise, returns -1 on failure, else the number of items still on the queue.

Implements ACE_Message_Queue_Base.

pulse()

int ACE_Message_Queue_NT::pulse ( )

virtual

Pulse the queue to wake up any waiting threads. Changes the queue state to PULSED; future enqueue/dequeue operations proceed as in ACTIVATED state.

Return values

The	queue's state before this call.

Implements ACE_Message_Queue_Base.

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

ACE_Message_Queue_NT::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

completion_port_

ACE_HANDLE ACE_Message_Queue_NT::completion_port_

private

Underlying NT IoCompletionPort.

cur_bytes_

size_t ACE_Message_Queue_NT::cur_bytes_

private

Current number of bytes in queue.

cur_count_

size_t ACE_Message_Queue_NT::cur_count_

private

Current number of messages in the queue.

cur_length_

size_t ACE_Message_Queue_NT::cur_length_

private

Current length of messages in queue.

cur_thrs_

DWORD ACE_Message_Queue_NT::cur_thrs_

private

Current number of threads waiting to dequeue messages.

lock_

ACE_SYNCH_MUTEX ACE_Message_Queue_NT::lock_

private

Synchronizer. This should really be an ACE_Recursive_Thread_Mutex but since this class is only supported on NT, it's okay to use ACE_Thread_Mutex here.

max_cthrs_

DWORD ACE_Message_Queue_NT::max_cthrs_

private

Maximum threads that can be released (and run) concurrently.

---

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

• Message_Queue_NT.h
• Message_Queue_NT.cpp
• Message_Queue_NT.inl