Matrix
C # queue with a DeQueue function that blocks while the queue is empty
The BlockingQueue encapsulates an ordinary C# queue to allow the DeQ function to block
if the queue is Empty. In addition, the queue holds a delegate to which an external
function can be registered. When an element is enqueued, it is automatically extracted
and passed to the registered function as a parameter.
Constructor for the BlockingQueue.
the delegate to which the processing function is registered.
Add an element into the Queue
the element to be entered into the queue
Returns the current number of elements in the queue
Integer containing the size
Remove all elements from the Queue
Delegate to which the processing function is registered.
Delegate to register the function to be notified when response messages are
received.
Defines the public interface to a Matrix Cell.
The Cell interface is the parent to all Matrix Cells. Its functions are used
in registering Cells to the framework, locating and communicating between Cells.
Most of the Functions have default implementations which do not change for one Cell
to another. These functions are marked as MATRIX INTERNAL FUNCTION and their implementation
code can be generated automatically for every Cell.
MATRIX INTERNAL FUNCTION - Logs the Cell into the Matrix registry
This function registers the Cell and makes its services available
to the rest of the Application. It also runs the Start Function defined by the
Cell to allow it to perform initialization operations
True if successful
MATRIX INTERNAL FUNCTION - Removes the Cell from the Matrix Registry
True if successful
MATRIX INTERNAL FUNCTION - Extracts the incoming messages from the Input Queue, forwards them
to be processed and returns the response objects
The Input Message to be processed
MATRIX INTERNAL FUNCTION - Extracts Messages from the response queue and retrieves the return values
for synchronous Message transfers
The Response Message to be processed
MATRIX INTERNAL FUNCTION - Accepts a Message and puts it into the Request queue for processing
The incoming Message
MATRIX INTERNAL FUNCTION - Accepts a Message for processing
The incoming Message
Defines whether the Message is a Request or a Reply
True for Response Messages and False for Request Messages
MATRIX INTERNAL FUNCTION - Returns the GUID of the Cell instance
System.Guid holding the Cell's GUID
MATRIX INTERNAL FUNCTION - Determines if the Cell can process a particular MessageType
The MessageType being queried
True if the Cell can accept Messages of the specified type
False if it cannot
Finds all the MessageTypes that the Cell can process
A string array containing the names of all the MessageType the
Cell can process
MATRIX INTERNAL FUNCTION - Returns a Clone of the MessageHandler Cell for the specified Messagetype
The name of the Message for which a Message Handler
is required
A Clone of the Message Handler Cell
MATRIX INTERNAL FUNCTION - Sends an asynchronous Message to either a local or remote Cell
The name of the Message to be sent
The arguments to be supplied to the Messsage Handler
The Address of remote Machine to which the Message is
to be delivered. An address of "0" will deliver the messsage to the local machine
True if successful
MATRIX INTERNAL FUNCTION - Sends a synchronous Message to either a local or remote Cell and waits for
the reply
The name of the Message to be sent
The arguments to be supplied to the Messsage Handler
The Address of remote Machine to which the Message is
to be delivered. An address of "0" will deliver the messsage to the local machine
An array of objects containing the reply to the request Message
MATRIX INTERNAL FUNCTION - Sends a synchronous Message to either a local or remote Cell and waits for
the reply
The name of the Message to be sent
The arguments to be supplied to the Messsage Handler
The Address of remote Machine to which the Message is
to be delivered. An address of "0" will deliver the messsage to the local machine
The Clone cell to which the message is to be delivered
An array of objects containing the reply to the request Message
Run as the Cell is loaded. Used for initialization and in Cells that perform Executive
operations.
This function can be used to perform the Initialization operations required by the Cell.
It is run on its own thread at the end of the registration process after the Cell has
been loaded. Cells that operate as Executives can use this Method to perform their operations
Used to process incoming messages and return the results.
The Process function has a partial implementation that is common to all Cells. Each MessageType
that is to be handled by the Cell should be listed as a case in the switch statement. Processing
can either be continued in the case block or delegated to a private function.
The ExecObject containing the Message Parameters
An object Array containing the result objects
switch(MessageType)
{
case "Matrix.Network.SendMessage":
ret = process_sendMessage(eo.getParams());
break;
}
Activated when the Cell receives a Response Message. Functions that handle response Messages
can register for the event. Used by the Matrix Internal Messaging Structure
The Clone Class is used to create copies of Cells to
allow stateful processing.
Some applications may require multiple instances of a
particular Cell. Clones can be created and registered to
the Mediator to allow dedicated Cell instances to be used.
Constructor for the Clone Class
The Guid of the Cell to be cloned
Returns the Guid of the Clone.
Guid object containing the Cell's Guid
Config loads the Configuration file and extracts the
properties required for setting up the Matrix
Constructor for the config class
Load the config file and extract properties
The folder name and location of the Repository
The IP Address of the Repository Server
The folder name and path to the Plugin Folder
The IP Address of the local machine
The port used by the Matrix Framework
The IP Address of the Address Server
Address of backup server where new Cells can be
installed.
Indicates whether new Cells are installed to the
backup server or to the requesting Machine
Basic Matrix Exception.
MatrixException Constructor
Overloaded MatrixException Constructor
String explaining cause of Exception
Matrix Exception thrown when a Message contains invalid type
or number of parameters
Constructor for MInvalidArgsException
Matrix Exception thrown when a Message format is invalid - either
an invalid XML document or the wrong type and placement of tags
Constructor for the MInvalidFormatException
Matrix Exception thrown when no handler is found for the requested
Message type
Constructor for the MNoRecipientException
Encapsulates the Message Details in a Class
Once a Message has been received, all the attributes
contained in XML format are stored into an ExecObject
instance for easy retrieval
Constructor for the ExecObject Class
True for Request Messages, False for Response Messages
Guid of the Source Cell
Guid of the Destination Cell
Guid of the Request Message
The name of the Message Type
The Return Values contained in the Message
The Message Parameters
Overloaded Constructor for the ExecObject Class
True for Request Messages, False for Response Messages
Guid of the Request Message
The Return Values contained in the Message
Checks whether the Message is a Request or a Response
True for Request Messages, False for Response Messages
Gets the Message Return Values
Object returned after the Message has been processed
Returns the name of the Message Type
String containing the Message Type Name
Returns the Guid of the Requesting Cell
string containing the Guid
Returns the Guid of the Responding Cell
string containing the Guid
Returns the Guid assigned to the Message
string containing the Guid
Returns the Parameters with which the Message was called
object array containing the parameters
The Matrix Class which Functions as a Mediator for Matrix
Applications.
The Matrix class contains static data structures and functions
that perform the activities of a Mediator. It registers Cells
as they are loaded and holds references to them in an indexed
table. It also facilitates communication between Cells by
accepting and forwarding Messages between them.
Registers the Cell to the Matrix Registry
The Cell to be registered
True if successful
Removes the Cell reference from the Registry
The Cell to be removed
True if successful
Registers Clone Cells to the Matrix Registry
The Cell to be Registered
True if successful
Removes a Clone Cell from the Registry
True if successful
Creates a Clone Cell
The name of the Message Type
whose Handler is to be cloned
The Guid of the created Clone
Accepts a Message to be forwarded.
String containing the message
Checks if the specified Cell is registered and returns a reference if it is
found.
The Guid of the required Cell
Empty reference to a Cell object to which the discovered
Cell is assigned
True if Cell is found
Checks if the specified Clone Cell is registered and returns a reference if it is
found.
The Guid of the required Cell
Empty reference to a Cell object to which the discovered
Cell is assigned
True if Cell is found
Forwards a Message to the Specified Cell
Object containing the message
The guid of the destination cell
Forwards a Response Message to the specified Cell
Object containing the message
The Guid of the Destination Cell
Forwards a Message to a specified Clone Cell
Object containing the message
The Guid of the Destination Cell
Discover the Location of the Handler to the specified Message Type
String containing the Message Type
String containing the location. Can represent either
a Guid, an IP Address or a null value
Trigger the start of the application by releasing all stored messages
To synchronize application startup, all incoming message are cache'd until
a flag is set indicating that all Cells have been loaded. This function is
called to set the flag and forward all messages in the cache.
Request the current list of Message Handlers registered to this node
String array containing the Capability List
Supports Creating and Parsing XML Messages in the
Matrix Format.
The Messaging class provides Functions for building
Requests and Responses, Serializing parameter and result
Objects and logic for Message Forwarding in the Mediator
Constructor for the Messaging Class
Build a Request Message based on the supplied parameters
The Guid of the Cell making the Request
The Message Type name of the request
Object reference which can be used to return the reply objects
Parameter objects for the Message
ID for the Request. It is created by the buildRequest function
and returned as an out argument
The Guid of the Receiver Cell
The IP Address of the Receiver Cell
The IP Address of the Requesting Cell
String containing the Request Message.
Utility function to convert a MemoryStream object to a String.
The MemoryStream to be converted
The String representing the contents of the MemoryStream
Build a Response Message based on the given parameters
The Request Message for which a Response is to be generated
Object containing the Return Values
The Guid of the Requesting Cell. It is read from the
Request Message and returned as an out argument
True if Response is to be delivered to a Remote Cell,
False if it is for a local Cell. Determined by the buildResponse function and returned
as an out argument
String containing the XML Response Message
Extracts the parameters of a XML message and uses the data
to create an ExecObject that can be used by a Cell to process
Requests or Responses.
The XML Message to be processed
An ExecObject containing Message parameters
Extracts the parameters of a Request message and uses the data
to create an ExecObject that can be used by a Cell to process
Requests.
XmlDocument object containing the Message
ExecObject containing the Request parameters
Extracts the parameters of a Response message and uses the data
to create an ExecObject that can be used by a Cell to process
Responses.
XmlDocument object containing the Message
ExecObject containing the Response parameters
Forwards a Message to the specified destination
The forwardRequest Function extracts Messages from the MatrixQueue
and processes them to identify the Cell or Location that they must be
delivered to. It them forwards the Message by calling the Send Function
or sending the Message to the Network Cell
The Message to be forwarded.
Encapsulates a Message in either a Network or Default Message to send it to the
Network and Default Cells
The Message Type name of the Message to be forwarded
The IP Adress of the Location the Cell must be sent to
The Message to be Forwarded.
Indicates whether the Message is sent to the Default Cell
or to the Network Cell.
True if successful.
Utility function to identify is a string contains a Guid
The String to be verfied
True if the string represents a Guid, False else
Utility function to serialize an object
The object to be serialized
The string representing the serialized object
Utility function to deserialize a string into an Object
The string to be deserialized
The object created from the String
Public property which contains the IP Address of the local
machine.
Object to hold return values extracted from a Response Message
The parameters contained in a Response Object are extracted and
stored in the ReturnObject to allow a Cell to easily access them
without having to parse XML.
Constructor for the ReturnObject Class.
The return values from the Response Message
The exception contained in the Response Message
Returns the Return Value from the Response Message
Object Array containing the Return Objects
Returns the Exception from the Response Message
Exception Object containing the exception
Indicates whether the Response Message contains an Exception Object.
True if processing of the Request produced an Exception
Enables Synchronized Message Collaboration.
The SyncWait Class allows Cells to synchronize Message Passing
and make blocking Message Calls that return values.
Constructor for the SyncWait Class
The Parent Cell that created this Class
The Guid of the Request Message for which
synchronization is required.
Register the check function to be notified when the parent Cell
receives a Response Message
Remove the SyncWait class from the Parent Cells onReceive
event Notification List
Check if the Response Message matches the one that is being waited for.
Blocking Function that waits till a response is received.
The time out allows recovery from failed Message deliveries
The Return Object extracted from the Response Message
Class to hold Information related to an OnReceive Event
When the parent Cell receives a Response Message, the ReceiveInfoEventArgs
is used to transfer the required result objects between the Cells response
and the registered SyncWait to allow the waiting Class to match Request IDs
and return the correct Return Objects.
Constructor for the ReceiveInfoEventArgs Class
The Id of the Message that triggered the event
The Result objects contained in the Response Message
Returns the Message ID
Guid containing the Message ID
Returns the Return Values
Object containing the Return Values