org.jlab.coda.cMsg.cMsgDomain.server

Class cMsgServerSubscribeInfo

java.lang.Object

org.jlab.coda.cMsg.cMsgDomain.server.cMsgServerSubscribeInfo

class cMsgServerSubscribeInfo
extends java.lang.Object

Class to store the record of a server client's subscription to a particular message subject, type, and namespace. It also stores a record of all subscribeAndGet calls to the same subject, type, and namespace. Used by the cMsgDomainServer class.

Version:

1.0

Author:

Carl Timmer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) cMsgClientInfo	info Client which created the subscription/subAndGet.
(package private) java.lang.String	namespace This refers to a cMsg subdomain's namespace in which this subscription resides.
(package private) java.util.HashMap<java.lang.Integer,cMsgCallbackAdapter>	subAndGetters This map contains all regular clients (servers do not call subscribeAndGet but use subscribe to implement it) who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int) with this exact subject, type, and namespace.
(package private) java.lang.String	subject Subject subscribed to.
(package private) int	subscribed If this is 1, the client did a subscription, else if 0 only subAndGets.
(package private) java.lang.String	type Type subscribed to.

Constructor Summary

Constructors

Constructor and Description
cMsgServerSubscribeInfo(java.lang.String subject, java.lang.String type, java.lang.String namespace, cMsgClientInfo info) Constructor used by cMsgDomainServer object basically for storage of subject, type, namespace and callbacks for subscribes.
cMsgServerSubscribeInfo(java.lang.String subject, java.lang.String type, java.lang.String namespace, cMsgClientInfo info, int id, cMsgCallbackAdapter cb) Constructor used by cMsgDomainServer object basically for storage of subject, type, namespace and callbacks for subAndGets.

Method Summary

Modifier and Type	Method and Description
void	addSubAndGetter(int id, cMsgCallbackAdapter cb) Adds an entry to a hashmap with the subscribeAndGet id as the key and the callback object as the value.
void	addSubscription() Calling this method means this client is now subscribed to this sub/type/namespace.
java.util.HashMap<java.lang.Integer,cMsgCallbackAdapter>	getSubAndGetters() Gets the HashMap containing the subscribeAndGet id generated by the originating client as the key (receiverSubscribeId which identifies the particular subscribeAndGet call in question), and the value which is the callback object of that subscribeAndGet.
boolean	isSubscribed() Is the client subscribed or are there only subAndGets?
int	numberOfSubscribers() Gets the number of subscriptions a client has to a subject, type, namespace combination.
void	removeSubAndGetter(int id) Removes an entry to a hashmap with the subscribeAndGet id as the key and the callback object as the value.
void	removeSubscription() Calling this method means this client is not subscribed to this sub/type/namespace anymore.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subject

java.lang.String subject

Subject subscribed to.

type

java.lang.String type

Type subscribed to.

namespace

java.lang.String namespace

This refers to a cMsg subdomain's namespace in which this subscription resides. It is useful only when another server becomes a client for means of bridging messages. In this case, this special client does not reside in 1 namespace but represents subscriptions from different namespaces. This is used on the server side.

info

cMsgClientInfo info

Client which created the subscription/subAndGet.

subscribed

int subscribed

If this is 1, the client did a subscription, else if 0 only subAndGets.

subAndGetters

java.util.HashMap<java.lang.Integer,cMsgCallbackAdapter> subAndGetters

This map contains all regular clients (servers do not call subscribeAndGet but use subscribe to implement it) who have called cMsg.subscribeAndGet(java.lang.String, java.lang.String, int) with this exact subject, type, and namespace. A count is keep of how many times subscribeAndGet for a particular client has been called. The client info object is the key and count is the value. This is used on the server side.

Constructor Detail

cMsgServerSubscribeInfo

public cMsgServerSubscribeInfo(java.lang.String subject,
                               java.lang.String type,
                               java.lang.String namespace,
                               cMsgClientInfo info)

Constructor used by cMsgDomainServer object basically for storage of subject, type, namespace and callbacks for subscribes.

Parameters:

subject - subscription subject

type - subscription type

namespace - subscription's namespace

info - client information object

cMsgServerSubscribeInfo

public cMsgServerSubscribeInfo(java.lang.String subject,
                               java.lang.String type,
                               java.lang.String namespace,
                               cMsgClientInfo info,
                               int id,
                               cMsgCallbackAdapter cb)

Constructor used by cMsgDomainServer object basically for storage of subject, type, namespace and callbacks for subAndGets.

Parameters:

subject - subscription subject

type - subscription type

namespace - subscription's namespace

info - client information object

id - receiverSubscribeId of subscribeAndGet request

cb - callback of subscribeAndGet

Method Detail

addSubscription

public void addSubscription()
                     throws cMsgException

Calling this method means this client is now subscribed to this sub/type/namespace. Previously only a subscribeAndGet to this sub/type/ns was done.

Throws:

cMsgException - if user tries to subscribe more than once (subscribeAndGet NOT included)

removeSubscription

public void removeSubscription()

Calling this method means this client is not subscribed to this sub/type/namespace anymore.

isSubscribed

public boolean isSubscribed()

Is the client subscribed or are there only subAndGets?

Returns:

true if client has a subscription, false if client only did subAndGets

getSubAndGetters

public java.util.HashMap<java.lang.Integer,cMsgCallbackAdapter> getSubAndGetters()

Gets the HashMap containing the subscribeAndGet id generated by the originating client as the key (receiverSubscribeId which identifies the particular subscribeAndGet call in question), and the value which is the callback object of that subscribeAndGet.

Returns:

hashmap of (id, callback object) key-value pairs of all subAndGets

addSubAndGetter

public void addSubAndGetter(int id,
                            cMsgCallbackAdapter cb)

Adds an entry to a hashmap with the subscribeAndGet id as the key and the callback object as the value.

Parameters:

id - id of subscribeAndGet call

cb - callback object

removeSubAndGetter

public void removeSubAndGetter(int id)

Removes an entry to a hashmap with the subscribeAndGet id as the key and the callback object as the value.

Parameters:

id - subscribeAndGet id key

numberOfSubscribers

public int numberOfSubscribers()

Gets the number of subscriptions a client has to a subject, type, namespace combination. This includes both subscribes and subAndGets.

Returns:

the number of subscriptions a client has to a subject, type, namespace combination including subscribes and subAndGets