org.jlab.coda.cMsg.cMsgDomain.subdomains

Class Dummy

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.Dummy

All Implemented Interfaces:

cMsgSubdomainInterface

public class Dummy
extends cMsgSubdomainAdapter

This class is a subdomain which does nothing. It was used for finding a memory leak in the cMsg server.

Constructor Summary

Constructors

Constructor and Description
Dummy()

Method Summary

Modifier and Type	Method and Description
void	handleClientShutdown() Method to handle a client or domain server (and therefore subdomain handler) shutdown.
void	handleSendAndGetRequest(cMsgMessageFull message) Method to synchronously get a single message by sending out a message which is responded to by its receiver(s).
void	handleSendRequest(cMsgMessageFull message) Method to handle a message sent by a domain client.
void	handleShutdownClientsRequest(java.lang.String client, boolean includeMe) Method to handle a request to shutdown clients 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 id) Method to handle a subscribe request sent by a domain client.
int	handleSyncSendRequest(cMsgMessageFull message) Method to handle a message sent by a domain client in synchronous mode.
void	handleUnSendAndGetRequest(int id) Method to remove a sendAndGet request previously sent by a domain client.
void	handleUnsubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) Method to remove a subscribeAndGet request previously sent by a domain client.
void	handleUnsubscribeRequest(java.lang.String subject, java.lang.String type, int id) Method to handle an unsubscribe request sent by a domain client.
boolean	hasSend() Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.
boolean	hasSendAndGet() Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the "handleSendAndGetRequest" method.
boolean	hasShutdown() Method to tell if the "shutdown" cMsg API function is implemented by this interface implementation in the "handleShutdownClientsRequest" 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) Method to register a domain client.
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 java.lang.Object

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

Constructor Detail

Dummy

public Dummy()

Method Detail

setUDLRemainder

public void setUDLRemainder(java.lang.String UDLRemainder)

Description copied from class: cMsgSubdomainAdapter

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

Description copied from class: cMsgSubdomainAdapter

Method to register a domain client.

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

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

handleSendRequest

public void handleSendRequest(cMsgMessageFull message)

Description copied from class: cMsgSubdomainAdapter

Method to handle a message sent by a domain client.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSendRequest in class cMsgSubdomainAdapter

Parameters:

message - message from sender

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull message)

Description copied from class: cMsgSubdomainAdapter

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:

message - message from sender

Returns:

response from subdomain handler

handleSubscribeAndGetRequest

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

Description copied from class: cMsgSubdomainAdapter

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

handleSendAndGetRequest

public void handleSendAndGetRequest(cMsgMessageFull message)

Description copied from class: cMsgSubdomainAdapter

Method to synchronously get a single message by sending out a message which is responded to by its receiver(s).

Specified by:

handleSendAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleSendAndGetRequest in class cMsgSubdomainAdapter

Parameters:

message - message requesting a response message

handleUnSendAndGetRequest

public void handleUnSendAndGetRequest(int id)

Description copied from class: cMsgSubdomainAdapter

Method to remove a sendAndGet request previously sent by a domain client.

Specified by:

handleUnSendAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleUnSendAndGetRequest in class cMsgSubdomainAdapter

Parameters:

id - unique (senderToken) id refering to specific sendAndGet

handleUnsubscribeAndGetRequest

public void handleUnsubscribeAndGetRequest(java.lang.String subject,
                                           java.lang.String type,
                                           int id)

Description copied from class: cMsgSubdomainAdapter

Method to remove a subscribeAndGet request previously sent by a domain client.

Specified by:

handleUnsubscribeAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleUnsubscribeAndGetRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

handleSubscribeRequest

public void handleSubscribeRequest(java.lang.String subject,
                                   java.lang.String type,
                                   int id)

Description copied from class: cMsgSubdomainAdapter

Method to handle a subscribe request sent by a domain client.

Specified by:

handleSubscribeRequest in interface cMsgSubdomainInterface

Overrides:

handleSubscribeRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

handleUnsubscribeRequest

public void handleUnsubscribeRequest(java.lang.String subject,
                                     java.lang.String type,
                                     int id)

Description copied from class: cMsgSubdomainAdapter

Method to handle an unsubscribe request sent by a domain client.

Specified by:

handleUnsubscribeRequest in interface cMsgSubdomainInterface

Overrides:

handleUnsubscribeRequest in class cMsgSubdomainAdapter

Parameters:

subject - subject of subscription

type - type of subscription

id - unique id

handleShutdownClientsRequest

public void handleShutdownClientsRequest(java.lang.String client,
                                         boolean includeMe)

Description copied from class: cMsgSubdomainAdapter

Method to handle a request to shutdown clients sent by a domain client.

Specified by:

handleShutdownClientsRequest in interface cMsgSubdomainInterface

Overrides:

handleShutdownClientsRequest in class cMsgSubdomainAdapter

Parameters:

client - client(s) to be shutdown

includeMe - if true, this client may be shutdown too

handleClientShutdown

public void handleClientShutdown()

Description copied from class: cMsgSubdomainAdapter

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

Specified by:

handleClientShutdown in interface cMsgSubdomainInterface

Overrides:

handleClientShutdown in class cMsgSubdomainAdapter

hasSend

public boolean hasSend()

Description copied from class: cMsgSubdomainAdapter

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 if send implemented in "handleSendRequest"

hasSyncSend

public boolean hasSyncSend()

Description copied from class: cMsgSubdomainAdapter

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 if send implemented in "handleSyncSendRequest"

hasSubscribeAndGet

public boolean hasSubscribeAndGet()

Description copied from class: cMsgSubdomainAdapter

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 if subscribeAndGet implemented in "handleSubscribeAndGetRequest"

hasSendAndGet

public boolean hasSendAndGet()

Description copied from class: cMsgSubdomainAdapter

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

Specified by:

hasSendAndGet in interface cMsgSubdomainInterface

Overrides:

hasSendAndGet in class cMsgSubdomainAdapter

Returns:

true if sendAndGet implemented in "handleSendAndGetRequest"

hasSubscribe

public boolean hasSubscribe()

Description copied from class: cMsgSubdomainAdapter

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 if subscribe implemented in "handleSubscribeRequest"

hasUnsubscribe

public boolean hasUnsubscribe()

Description copied from class: cMsgSubdomainAdapter

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 if unsubscribe implemented in "handleUnsubscribeRequest"

hasShutdown

public boolean hasShutdown()

Description copied from class: cMsgSubdomainAdapter

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

Specified by:

hasShutdown in interface cMsgSubdomainInterface

Overrides:

hasShutdown in class cMsgSubdomainAdapter

Returns:

true if shutdown implemented in "handleShutdownClientsRequest"