org.jlab.coda.cMsg.cMsgDomain.subdomains

Class CA

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.CA

All Implemented Interfaces:

cMsgSubdomainInterface

public class CA
extends cMsgSubdomainAdapter

cMsg subdomain handler for channel access (CA) subdomain. WARNING: This class may need some thread-safety measures added (Timmer). Executes send/get as CA put/get command. Uses JCA+CAJ.

Version:

1.0

Author:

Elliott Wolin

Constructor Summary

Constructors

Constructor and Description
CA()

Method Summary

Modifier and Type	Method and Description
void	handleClientShutdown() Method to handle a client or domain server (and therefore subdomain handler) shutdown.
void	handleSendRequest(cMsgMessageFull msg) Method to handle a message sent by a domain client.
void	handleSubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) Method to synchronously get a single message from the server for a one-time subscription of a subject and type.
void	handleSubscribeRequest(java.lang.String subject, java.lang.String type, int receiverSubscribeId) Performs CA monitorOn.
int	handleSyncSendRequest(cMsgMessageFull msg) Method to handle a message sent by a domain client in synchronous mode.
void	handleUnsubscribeRequest(java.lang.String subject, java.lang.String type, int receiverSubscribeId) Performs CA monitorOff.
boolean	hasSend() Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.
boolean	hasSubscribe() Method to tell if the "subscribe" cMsg API function is implemented by this interface implementation in the "handleSubscribeRequest" method.
boolean	hasSubscribeAndGet() Method to tell if the "subscribeAndGet" cMsg API function is implemented by this interface implementation in the "handleSubscribeAndGetRequest" method.
boolean	hasSyncSend() Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.
boolean	hasUnsubscribe() Method to tell if the "unsubscribe" cMsg API function is implemented by this interface implementation in the "handleUnsubscribeRequest" method.
void	registerClient(cMsgClientInfo info) Creates JCA, context, and channel objects.
void	setUDLRemainder(java.lang.String UDLRemainder) Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

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

handleSendAndGetRequest, handleShutdownClientsRequest, handleUnSendAndGetRequest, handleUnsubscribeAndGetRequest, hasSendAndGet, hasShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

CA

public CA()

Method Detail

hasSend

public boolean hasSend()

Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.

Specified by:

hasSend in interface cMsgSubdomainInterface

Overrides:

hasSend in class cMsgSubdomainAdapter

Returns:

true

hasSyncSend

public boolean hasSyncSend()

Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.

Specified by:

hasSyncSend in interface cMsgSubdomainInterface

Overrides:

hasSyncSend in class cMsgSubdomainAdapter

Returns:

true

hasSubscribeAndGet

public boolean hasSubscribeAndGet()

Method to tell if the "subscribeAndGet" cMsg API function is implemented by this interface implementation in the "handleSubscribeAndGetRequest" method.

Specified by:

hasSubscribeAndGet in interface cMsgSubdomainInterface

Overrides:

hasSubscribeAndGet in class cMsgSubdomainAdapter

Returns:

true

hasSubscribe

public boolean hasSubscribe()

Method to tell if the "subscribe" cMsg API function is implemented by this interface implementation in the "handleSubscribeRequest" method.

Specified by:

hasSubscribe in interface cMsgSubdomainInterface

Overrides:

hasSubscribe in class cMsgSubdomainAdapter

Returns:

true

hasUnsubscribe

public boolean hasUnsubscribe()

Method to tell if the "unsubscribe" cMsg API function is implemented by this interface implementation in the "handleUnsubscribeRequest" method.

Specified by:

hasUnsubscribe in interface cMsgSubdomainInterface

Overrides:

hasUnsubscribe in class cMsgSubdomainAdapter

Returns:

true

setUDLRemainder

public void setUDLRemainder(java.lang.String UDLRemainder)

Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Specified by:

setUDLRemainder in interface cMsgSubdomainInterface

Overrides:

setUDLRemainder in class cMsgSubdomainAdapter

Parameters:

UDLRemainder - last part of the UDL appropriate to the subdomain handler

registerClient

public void registerClient(cMsgClientInfo info)
                    throws cMsgException

Creates JCA, context, and channel objects.

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

cMsgException - if unable to register

handleSendRequest

public void handleSendRequest(cMsgMessageFull msg)
                       throws cMsgException

Method to handle a message sent by a domain client.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Throws:

cMsgException - if a channel to the client is closed, cannot be created, or socket properties cannot be set

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull msg)
                          throws cMsgException

Method to handle a message sent by a domain client in synchronous mode. It requries an integer response from the subdomain handler.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSyncSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Returns:

0

Throws:

cMsgException - if a channel to the client is closed, cannot be created, or socket properties cannot be set

handleSubscribeAndGetRequest

public void handleSubscribeAndGetRequest(java.lang.String subject,
                                         java.lang.String type,
                                         int id)
                                  throws cMsgException

Method to synchronously get a single message from the server for a one-time subscription of a subject and type.

Specified by:

handleSubscribeAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleSubscribeAndGetRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - if message delivery to client fails

handleSubscribeRequest

public void handleSubscribeRequest(java.lang.String subject,
                                   java.lang.String type,
                                   int receiverSubscribeId)
                            throws cMsgException

Performs CA monitorOn.

Specified by:

handleSubscribeRequest in interface cMsgSubdomainInterface

Overrides:

handleSubscribeRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject subscribed to

type - type subscribed to

receiverSubscribeId - unique id

Throws:

cMsgException - if no client information is available or a subscription for this subject and type already exists

handleUnsubscribeRequest

public void handleUnsubscribeRequest(java.lang.String subject,
                                     java.lang.String type,
                                     int receiverSubscribeId)
                              throws cMsgException

Performs CA monitorOff.

Specified by:

handleUnsubscribeRequest in interface cMsgSubdomainInterface

Overrides:

handleUnsubscribeRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject of subscription

type - type of subscription

receiverSubscribeId - unique id

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleClientShutdown

public void handleClientShutdown()
                          throws cMsgException

Method to handle a client or domain server (and therefore subdomain handler) shutdown.

Specified by:

handleClientShutdown in interface cMsgSubdomainInterface

Overrides:

handleClientShutdown in class cMsgSubdomainAdapter

Throws:

cMsgException - if channel access exception thrown