Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

NetworkMessage Class Reference

Inheritance diagram for NetworkMessage:

NetworkQueue IConsumer NetworkTask List of all members.

Public Member Functions

 this (ICluster cluster, char[] channel, IEventListener listener=null)
void cancel ()
void put (IMessage message)

Private Member Functions

 this (ICluster cluster, char[] channel)
IConsumer createConsumer (IEventListener listener)
void put (IPayload payload)
IPayload get ()

Static Private Member Functions

 this ()

Private Attributes

IChannel reply
IConsumer consumer

Member Function Documentation

this ICluster  cluster,
char[]  channel,
IEventListener  listener = null
[inline]
 

Construct a NetworkMessage gateway on the provided QOS cluster for the specified channel. Each subsequent queue operation will take place over the given channel.

You can listen for cluster replies by providing an optional IEventListener. Outgoing messages will be tagged appropriately such that a consumer can respond using IEvent.reply().

Reimplemented in NetworkTask.

Definition at line 127 of file NetworkQueue.d.

void cancel  )  [inline]
 

Cancel the listener. No more events will be dispatched to the reply IEventListener.

Reimplemented from IConsumer.

Definition at line 145 of file NetworkQueue.d.

References IConsumer::cancel().

void put IMessage  message  )  [inline]
 

Add an IMessage entry to the corresponding queue. This will throw a ClusterFullException if there is no space left in the clustered queue.

Definition at line 159 of file NetworkQueue.d.

References IChannel::getName(), and IMessage::setReply().

Referenced by testClusterMessage().

this ICluster  cluster,
char[]  channel
[inline, inherited]
 

Construct a NetworkQueue gateway on the provided QOS cluster for the specified channel. Each subsequent queue operation will take place over the given channel.

Reimplemented from Client.

Definition at line 59 of file NetworkQueue.d.

this  )  [inline, static, inherited]
 

Definition at line 63 of file Client.d.

References Client::EmptyMessage.

IConsumer createConsumer IEventListener  listener  )  [inline, inherited]
 

Create a listener for this channel. Listeners are invoked when new content is placed into a corresponding queue.

Definition at line 71 of file NetworkQueue.d.

References ICluster::createConsumer().

Referenced by testClusterMessage(), and testClusterQueue().

void put IPayload  payload  )  [inline, inherited]
 

Add an IPayload entry to the corresponding queue. This will throw a ClusterFullException if there is no space left in the clustered queue.

Definition at line 84 of file NetworkQueue.d.

References ICluster::putQueue().

Referenced by testClusterQueue().

IPayload get  )  [inline, inherited]
 

Query the cluster for queued entries on our corresponding channel. Returns, and removes, a matching entry from the cluster. This is the synchronous (polling) approach; you should use createConsumer() instead for asynchronous style notification instead.

Definition at line 99 of file NetworkQueue.d.

References ICluster::getQueue().


Member Data Documentation

IChannel reply [private]
 

Definition at line 112 of file NetworkQueue.d.

IConsumer consumer [private]
 

Definition at line 113 of file NetworkQueue.d.


The documentation for this class was generated from the following file:
Generated on Sun Nov 7 19:07:08 2004 for Mango by doxygen 1.3.6