Queue class.

A queue is ordered list of elements that is used to pass information between related or unrelated processes.

You can construct and destruct objects of this class.

Source:

pm_queue.h:30

Author:

Dmitry A.Steklenev

Version:

$Revision: 1.4 $

Entity	Inherited From	Type	Scope	Short Description
PMQueue		constructor	public	Creates a queue object.
~PMQueue		destructor	public	Destroys the queue object.
clear		method	public	Purges a queue of all its elements.
empty		method	public	Is a queue empty.
read		method	public	Reads an element from a queue.
peek		method	public	Examines a queue element without removing it from the queue.
peek		method	public	Examines a queue element without removing it from the queue.
write		method	public	Adds an element to a queue.

Creates a queue object.

Source:

pm_queue.h:34

Code:

public PMQueue (

)

Destroys the queue object.

Source:

pm_queue.h:36

Code:

public ~ PMQueue ( )

Purges a queue of all its elements.

Source:

pm_queue.h:39

Code:

public void clear (

)

Is a queue empty.

Source:

pm_queue.h:41

Code:

public BOOL empty (

) const

Reads an element from a queue.

Source:

pm_queue.h:51

Params:

request	An event code that is specified by the application.
data	A pointer to the data that is being removed.
priority	The address of the element's priority.

Code:

public BOOL read (	ULONG * request ,
	void * * data = NULL ,
	ULONG * priority = NULL )

Examines a queue element without removing it from the queue.

Source:

pm_queue.h:61

Params:

request	An event code that is specified by the application.
data	A pointer to the examined data.
priority	The address of the element's priority.

Code:

public BOOL peek (	ULONG * request ,
	void * * data = NULL ,
	ULONG * priority = NULL )

Examines a queue element without removing it from the queue.

Source:

pm_queue.h:73

Params:

first	First event code.
last	Last event code.

Returns:

TRUE if a next queue element has a event code in range specified by the first and last inclusive.

Code:

public BOOL peek (	ULONG first ,
	ULONG last )

Adds an element to a queue.

Source:

pm_queue.h:83

Params:

request	An event code that is specified by the application.
data	A data to be placed into the queue.
priority	The priority value of the element that is being added to the queue.

Code:

public void write (	ULONG request ,
	void * data = NULL ,
	ULONG priority = 0 )