|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface cMsgSubdomainInterface
This interface is an API for an object that a domain server uses to respond to client demands. An implementation of this interface handles all communication with a particular subdomain (such as SmartSockets or JADE agents). Implementors of this interface must understand that each client using cMsg will have its own handler object from a class implementing this interface. Several clients may concurrently use objects of the same class. Thus implementations must be thread-safe. Furthermore, when the name server shuts dowm, the method handleServerShutdown may be executed more than once for the same reason.
Method Summary | |
---|---|
void |
handleClientShutdown()
Method to handle a client or domain server (and therefore subdomain handler) shutdown. |
void |
handleKeepAlive()
Method to handle a keepalive sent by a domain client checking to see if the domain server is still up. |
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(org.jlab.coda.cMsg.cMsgMessageFull)
method. |
boolean |
hasSendAndGet()
Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the handleSendAndGetRequest(org.jlab.coda.cMsg.cMsgMessageFull)
method. |
boolean |
hasShutdown()
Method to tell if the "shutdown" cMsg API function is implemented by this interface implementation in the handleShutdownClientsRequest(java.lang.String, boolean)
method. |
boolean |
hasSubscribe()
Method to tell if the "subscribe" cMsg API function is implemented by this interface implementation in the handleSubscribeRequest(java.lang.String, java.lang.String, int)
method. |
boolean |
hasSubscribeAndGet()
Method to tell if the "subscribeAndGet" cMsg API function is implemented by this interface implementation in the handleSubscribeAndGetRequest(java.lang.String, java.lang.String, int)
method. |
boolean |
hasSyncSend()
Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the handleSyncSendRequest(org.jlab.coda.cMsg.cMsgMessageFull)
method. |
boolean |
hasUnsubscribe()
Method to tell if the "unsubscribe" cMsg API function is implemented by this interface implementation in the handleUnsubscribeRequest(java.lang.String, java.lang.String, int)
method. |
void |
registerClient(cMsgClientInfo info)
Method to register a domain client. |
void |
setMessageDeliverer(cMsgDeliverMessageInterface deliverer)
Method to give the subdomain handler on object able to deliver messages to the 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. |
Method Detail |
---|
void setUDLRemainder(java.lang.String UDLRemainder) throws cMsgException
UDLRemainder
- last part of the UDL appropriate to the subdomain handler
cMsgException
void setMessageDeliverer(cMsgDeliverMessageInterface deliverer) throws cMsgException
deliverer
- object able to deliver messages to the client
cMsgException
void registerClient(cMsgClientInfo info) throws cMsgException
info
- information about client
cMsgException
void handleSendRequest(cMsgMessageFull message) throws cMsgException
message
- message from sender
cMsgException
int handleSyncSendRequest(cMsgMessageFull message) throws cMsgException
message
- message from sender
cMsgException
void handleSubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) throws cMsgException
subject
- message subject subscribed totype
- message type subscribed toid
- message id
cMsgException
void handleUnsubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) throws cMsgException
subject
- message subject subscribed totype
- message type subscribed toid
- message id
cMsgException
void handleSendAndGetRequest(cMsgMessageFull message) throws cMsgException
message
- message requesting what sort of response message to get
cMsgException
void handleUnSendAndGetRequest(int id) throws cMsgException
id
- message id refering to these specific subject and type values
cMsgException
void handleSubscribeRequest(java.lang.String subject, java.lang.String type, int id) throws cMsgException
subject
- message subject subscribed totype
- message type subscribed toid
- message id
cMsgException
void handleUnsubscribeRequest(java.lang.String subject, java.lang.String type, int id) throws cMsgException
subject
- message subject subscribed totype
- message type subscribed toid
- message id
cMsgException
void handleShutdownClientsRequest(java.lang.String client, boolean includeMe) throws cMsgException
client
- client(s) to be shutdownincludeMe
- if true, this client may be shutdown too
cMsgException
void handleKeepAlive() throws cMsgException
cMsgException
void handleClientShutdown() throws cMsgException
cMsgException
boolean hasSend()
handleSendRequest(org.jlab.coda.cMsg.cMsgMessageFull)
method.
handleSendRequest(org.jlab.coda.cMsg.cMsgMessageFull)
boolean hasSyncSend()
handleSyncSendRequest(org.jlab.coda.cMsg.cMsgMessageFull)
method.
handleSyncSendRequest(org.jlab.coda.cMsg.cMsgMessageFull)
boolean hasSubscribeAndGet()
handleSubscribeAndGetRequest(java.lang.String, java.lang.String, int)
method.
handleSubscribeAndGetRequest(java.lang.String, java.lang.String, int)
boolean hasSendAndGet()
handleSendAndGetRequest(org.jlab.coda.cMsg.cMsgMessageFull)
method.
handleSendAndGetRequest(org.jlab.coda.cMsg.cMsgMessageFull)
boolean hasSubscribe()
handleSubscribeRequest(java.lang.String, java.lang.String, int)
method.
handleSubscribeRequest(java.lang.String, java.lang.String, int)
boolean hasUnsubscribe()
handleUnsubscribeRequest(java.lang.String, java.lang.String, int)
method.
handleUnsubscribeRequest(java.lang.String, java.lang.String, int)
boolean hasShutdown()
handleShutdownClientsRequest(java.lang.String, boolean)
method.
handleShutdownClientsRequest(java.lang.String, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |