Aztec® Programming Language
Version 1.1 Alpha 2

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

Download Aztec

Search        Contact Us

I can still make it... I can still stand tall.

'Cause I've got my girl... to get me through it all.

- Bob Seger

 

aztec.util.PrimitiveRefQueueEvent

public class PrimitiveRefQueueEvent<T> from<Event>

Base

Event

PrimitiveRefQueueEvent<>

The PrimitiveRefQueueEvent class is a "template" based class that takes a class name as an argument to indicate what type of primitive class reference 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 reference queue. This event occurs when an item is added to a PrimitiveRefQueue<> using 'AddItem()' or 'AddExpressItem()'. The PrimitiveRefQueue<> 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 PrimitiveRefQueueEvent<> 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 PrimitiveRefQueueEvent<T> and PrimitiveRefQueue<T> classes work together with each specific implementation of the template. When a PrimitiveRefQueue<string> class is created, the PrimitiveRefQueueEvent<string> class is also created automatically.

 

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

 

PrimitiveRefQueueEvent<> Methods

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

Derived Classes

See Also

  


PrimitiveRefQueueEvent()

public method PrimitiveRefQueueEvent(PrimitiveRefQueue<T> AssociatedQueue)

Parameters

AssociatedQueue

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

Return Value

None

Description

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

 

PrimitiveRefQueueEvent<> Class


PrimitiveRefQueue()

public method<PrimitiveRefQueue<T>> PrimitiveRefQueue()

Parameters

None

Return Value

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

Description

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

 

PrimitiveRefQueueEvent<> Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec