Aztec® Programming Language
Version 1.1 Alpha 2

Copyright © 2010-2017, Aztec Development Group, All Rights Reserved

Download Aztec

Search        Contact Us

Magic mirror... If we only could...

Try to see ourselves as others would.

- Leon Russell

 

aztec.util.PrimitiveQueueEvent

public class PrimitiveQueueEvent<T> from<Event>

Base

Event

PrimitiveQueueEvent<>

The PrimitiveQueueEvent class is a "template" based class that takes a class name as an argument to indicate what type of primitive class value is being stored in the queue the event is associated with. It provides an event class for handling receive events for a template based primitive queue. This event occurs when an item is added to a PrimitiveQueue<> using 'AddItem()' or 'AddExpressItem()'. The PrimitiveQueue class supports this event and it is an effective mechanism for thread to thread communication. A "server oriented" thread can set up one or more PrimitiveQueueEvent<> handlers and wait (using Thread.EventMode()), coming to life every time an item is added to a queue. The event handler can then retrieve the item from the queue and process it accordingly.

 

The PrimitiveQueueEvent<T> and PrimitiveQueue<T> classes work together with each specific implementation of the template. When a PrimitiveQueue<string> class is created, the PrimitiveQueueEvent<string> class is also created automatically.

 

Note that the description of the PrimitiveQueueEvent<> class below uses "T" as the placeholder in the class definition. It will be used throughout the class as a method argument and a retun type. When a specific implementation of the PrimitiveQueueEvent<> class is created, the "T" will be replaced with the primitive class that was passed into the PrimitiveQueueEvent<> class definition.

 

PrimitiveQueueEvent<> Methods

PrimitiveQueueEvent() Constructor for the PrimitiveQueueEvent<> class
PrimitiveQueue() Returns a reference to the "PrimitiveQueue<>" object which had an item added to it

Derived Classes

See Also

  


PrimitiveQueueEvent()

public method PrimitiveQueueEvent(PrimitiveQueue<T> AssociatedQueue)

Parameters

AssociatedQueue

The class specific primitive value queue containing the item which caused the event

Return Value

None

Description

Constructor for the PrimitiveQueueEvent<> class. The PrimitiveQueue<> object that had an item added to it is passed in.

 

PrimitiveQueueEvent<> Class


PrimitiveQueue()

public method<PrimitiveQueue<T>> PrimitiveQueue()

Parameters

None

Return Value

Reference to the class specific primitive value queue associated with the receive event

Description

This method returns the "PrimitiveQueue" reference associated with the PrimitiveQueueEvent. This is a "primitive class specific" queue, based on the actual Aztec class used in this PrimitiveQueue<> and PrimitiveQueueEvent<> implementation.

 

PrimitiveQueueEvent<> Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec