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

Client Class Reference

Inheritance diagram for Client:

CacheInvalidatee CacheInvalidator NetworkAlert NetworkQueue NetworkCache NetworkMessage NetworkCombo NetworkTask List of all members.

Public Member Functions

 this (ICluster cluster, char[] channel)
IChannel getChannel ()
ICluster getCluster ()
long getTime ()
IChannel createChannel (char[] name)

Static Public Member Functions

 this ()

Static Public Attributes

NullMessage EmptyMessage

Private Attributes

IChannel channel
ICluster cluster

Detailed Description

The base class for all cluster clients (such as CacheInvalidator) which acts simply as a container for the operating IChannel and the configured ICluster. The former specifies something akin to a 'topic' in the pub/sub world, while the latter provides access to the underlying functional substrate (the QOS implementation).

Definition at line 56 of file Client.d.


Member Function Documentation

this  )  [inline, static]
 

Definition at line 63 of file Client.d.

References EmptyMessage.

this ICluster  cluster,
char[]  channel
[inline]
 

Construct this client with the specified channel and cluster. The former specifies something akin to a 'topic', whilst the latter provides access to the underlying functional substrate (the QOS implementation). A good way to think about channels is to map them directly to a class name. That is, since you send and recieve classes on a channel, you might utilize the class name as the channel name (this.classinfo.name).

Reimplemented in CacheInvalidator, NetworkAlert, NetworkCache, and NetworkQueue.

Definition at line 80 of file Client.d.

References channel, and cluster.

IChannel getChannel  )  [inline]
 

Return the channel we're tuned to

Definition at line 94 of file Client.d.

References channel.

ICluster getCluster  )  [inline]
 

Return the cluster specified during construction

Definition at line 105 of file Client.d.

References cluster.

long getTime  )  [inline]
 

Return the number of milliseconds since Jan 1st 1970

Definition at line 116 of file Client.d.

IChannel createChannel char[]  name  )  [inline]
 

Create a channel with the specified name. A channel represents something akin to a publush/subscribe topic, or a radio station. These are used to segregate cluster operations into a set of groups, where each group is represented by a channel. Channel names are whatever you want then to be; use of dot notation has proved useful in the past. In fact, a good way to think about channels is to map them directly to a class name. That is, since you typically send and recieve classes on a channel, you might utilize the class name as the channel (this.classinfo.name).

Definition at line 136 of file Client.d.

References cluster, and ICluster::createChannel().


Member Data Documentation

IChannel channel [private]
 

Definition at line 58 of file Client.d.

Referenced by getChannel(), and this().

ICluster cluster [private]
 

Definition at line 59 of file Client.d.

Referenced by createChannel(), getCluster(), and this().

NullMessage EmptyMessage [static]
 

Definition at line 61 of file Client.d.

Referenced by this().


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