Aztec® Programming Language
Version 1.1 Alpha 2

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

Download Aztec

Search        Contact Us

Don't forget this fact...

You can't get it back.

- J.J. Cale

 

aztec.util.QueueEvent

public class QueueEvent<T> from<Event>

Base

Event

QueueEvent<>

The QueueEvent class is a "template" based class that takes a class name as an argument to indicate what type of class is being stored in the queue the event is associated with. It provides an event class for handling receive events for a template based queue. This event occurs when an item is added to a Queue<> using 'AddItem()' or 'AddExpressItem()'. The Queue 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 QueueEvent<> 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 QueueEvent<T> and Queue<T> classes work together with each specific implementation of the template. When a Queue<Thread> class is created, the QueueEvent<Thread> class is also created automatically.

 

Note that the description of the QueueEvent<> 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 QueueEvent<> class is created, the "T" will be replaced with the class that was passed into the QueueEvent<> class definition.

 

QueueEvent<> Methods

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

Derived Classes

See Also

  


QueueEvent()

public method QueueEvent(Queue<T> AssociatedQueue)

Parameters

AssociatedQueue

The class specific queue containing the item which caused the event

Return Value

None

Description

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

 

QueueEvent<> Class


Queue()

public method<Queue<T>> Queue()

Parameters

None

Return Value

Reference to the class specific queue associated with the receive event

Description

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

 

QueueEvent<> Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec