org.jlab.coda.cMsg.RCMulticastDomain

Class RCMulticast

java.lang.Object

org.jlab.coda.cMsg.common.cMsgDomainAdapter

org.jlab.coda.cMsg.RCMulticastDomain.RCMulticast

All Implemented Interfaces:

cMsgDomainInterface

public class RCMulticast
extends cMsgDomainAdapter

This class implements the runcontrol multicast (rcm) domain.

Version:

1.0

Author:

Carl Timmer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RCMulticast.Multicaster This class defines a thread to multicast a UDP packet to the RC Multicast server every second.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	acceptingClients Only allow response to rc clients if server is properly started.
(package private) java.lang.String	expid Runcontrol's experiment id.
(package private) boolean	hasSubscription Only allow response to rc clients if we have a subscription to pass client info to.
(package private) int	localTempPort The local port used temporarily while multicasting for other rc multicast servers.
(package private) java.util.concurrent.CountDownLatch	multicastResponse Signal to coordinate the multicasting and waiting for responses.
(package private) java.lang.String	respondingHost The host of the responding server to initial multicast probes of the local subnet.
(package private) java.util.Set<cMsgSubscription>	subscriptions Collection of all of this server's subscriptions which are cMsgSubscription objects.
(package private) int	udpPort This runcontrol multicast server's UDP listening port obtained from UDL or default value.

Fields inherited from class org.jlab.coda.cMsg.common.cMsgDomainAdapter

connected, debug, description, domain, host, name, receiving, shutdownHandler, UDL, UDLremainder

Constructor Summary

Constructors

Constructor and Description
RCMulticast()

Method Summary

Modifier and Type	Method and Description
void	connect() Method to connect to rc clients from this server.
void	disconnect() Method to stop listening for packets from rc clients.
void	send(cMsgMessage message) Method to send an abort command to the rc client.
cMsgSubscriptionHandle	subscribe(java.lang.String subject, java.lang.String type, cMsgCallbackInterface cb, java.lang.Object userObj) Method to subscribe to receive messages from rc clients.
void	unsubscribe(cMsgSubscriptionHandle obj) Method to unsubscribe a previous subscription to receive messages of a subject and type from the domain.

Methods inherited from class org.jlab.coda.cMsg.common.cMsgDomainAdapter

flush, getCurrentUDL, getDebug, getDescription, getDomain, getHost, getInfo, getName, getServerHost, getServerPort, getShutdownHandler, getUDL, getUDLRemainder, isConnected, isReceiving, monitor, sendAndGet, setDebug, setDescription, setName, setShutdownHandler, setUDL, setUDLRemainder, shutdownClients, shutdownServers, start, stop, subscribeAndGet, syncSend

Methods inherited from class java.lang.Object

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

Field Detail

udpPort

int udpPort

This runcontrol multicast server's UDP listening port obtained from UDL or default value.

localTempPort

int localTempPort

The local port used temporarily while multicasting for other rc multicast servers.

multicastResponse

java.util.concurrent.CountDownLatch multicastResponse

Signal to coordinate the multicasting and waiting for responses.

respondingHost

java.lang.String respondingHost

The host of the responding server to initial multicast probes of the local subnet.

expid

java.lang.String expid

Runcontrol's experiment id.

acceptingClients

volatile boolean acceptingClients

Only allow response to rc clients if server is properly started.

hasSubscription

volatile boolean hasSubscription

Only allow response to rc clients if we have a subscription to pass client info to.

subscriptions

java.util.Set<cMsgSubscription> subscriptions

Collection of all of this server's subscriptions which are cMsgSubscription objects. This set is synchronized.

Constructor Detail

RCMulticast

public RCMulticast()
            throws cMsgException

Throws:

cMsgException

Method Detail

connect

public void connect()
             throws cMsgException

Method to connect to rc clients from this server.

Specified by:

connect in interface cMsgDomainInterface

Overrides:

connect in class cMsgDomainAdapter

Throws:

cMsgException - if there are problems parsing the UDL or creating the UDP socket

disconnect

public void disconnect()

Method to stop listening for packets from rc clients.

Specified by:

disconnect in interface cMsgDomainInterface

Overrides:

disconnect in class cMsgDomainAdapter

send

public void send(cMsgMessage message)
          throws cMsgException

Method to send an abort command to the rc client. Fill in the senderHost with the host and the userInt with the port of the rc client to abort.

Specified by:

send in interface cMsgDomainInterface

Overrides:

send in class cMsgDomainAdapter

Parameters:

message - message to send

Throws:

cMsgException - if there are communication problems with the rc client

subscribe

public cMsgSubscriptionHandle subscribe(java.lang.String subject,
                                        java.lang.String type,
                                        cMsgCallbackInterface cb,
                                        java.lang.Object userObj)
                                 throws cMsgException

Method to subscribe to receive messages from rc clients. In this domain, subject and type are ignored and set to the preset values of "s" and "t".

Specified by:

subscribe in interface cMsgDomainInterface

Overrides:

subscribe in class cMsgDomainAdapter

Parameters:

subject - ignored and set to "s"

type - ignored and set to "t"

cb - callback object whose single method is called upon receiving a message of subject and type

userObj - any user-supplied object to be given to the callback method as an argument

Returns:

handle object to be used for unsubscribing

Throws:

cMsgException - if the callback, subject and/or type is null or blank; an identical subscription already exists; if not connected to an rc client

unsubscribe

public void unsubscribe(cMsgSubscriptionHandle obj)
                 throws cMsgException

Method to unsubscribe a previous subscription to receive messages of a subject and type from the domain.

Specified by:

unsubscribe in interface cMsgDomainInterface

Overrides:

unsubscribe in class cMsgDomainAdapter

Parameters:

obj - the object returned from a subscribe call

Throws:

cMsgException - if there is no connection with rc clients; object is null