|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface cMsgDomainInterface
This interface is the cMsg client API for cMsg domain.
Method Summary | |
---|---|
void |
connect()
Method to connect to a particular domain server. |
void |
disconnect()
Method to close the connection to the domain server. |
void |
flush(int timeout)
Method to force cMsg client to send pending communications with domain server. |
java.lang.String |
getDescription()
Get the client's description. |
java.lang.String |
getDomain()
Get the name of the domain connected to. |
java.lang.String |
getHost()
Get the host the client is running on. |
java.lang.String |
getName()
Get the name of the client. |
cMsgShutdownHandlerInterface |
getShutdownHandler()
Method to get the shutdown handler of the client. |
java.lang.String |
getString()
Get a string that the implementing class wants to send back to the user. |
java.lang.String |
getUDL()
Get the client's UDL. |
java.lang.String |
getUDLRemainder()
Get the client's UDL remainder. |
boolean |
isConnected()
Method to determine if this object is still connected to the domain server or not. |
boolean |
isReceiving()
Method telling whether callbacks are activated or not. |
cMsgMessage |
monitor(java.lang.String command)
This method is a synchronous call to receive a message containing monitoring data which describes the state of the cMsg domain the user is connected to. |
void |
send(cMsgMessage message)
Method to send a message to the domain server for further distribution. |
cMsgMessage |
sendAndGet(cMsgMessage message,
int timeout)
The message is sent as it would be in the send(org.jlab.coda.cMsg.cMsgMessage) method. |
void |
setDescription(java.lang.String description)
Set the description of the client. |
void |
setName(java.lang.String name)
Set the name of the client. |
void |
setShutdownHandler(cMsgShutdownHandlerInterface handler)
Method to set the shutdown handler of the client. |
void |
setUDL(java.lang.String UDL)
Set the UDL of the client. |
void |
setUDLRemainder(java.lang.String UDLRemainder)
Set the UDL remainder of the client. |
void |
shutdownClients(java.lang.String client,
boolean includeMe)
Method to shutdown the given clients. |
void |
shutdownServers(java.lang.String server,
boolean includeMyServer)
Method to shutdown the given servers. |
void |
start()
Method to start or activate the subscription callbacks. |
void |
stop()
Method to stop or deactivate the subscription callbacks. |
java.lang.Object |
subscribe(java.lang.String subject,
java.lang.String type,
cMsgCallbackInterface cb,
java.lang.Object userObj)
Method to subscribe to receive messages of a subject and type from the domain server. |
cMsgMessage |
subscribeAndGet(java.lang.String subject,
java.lang.String type,
int timeout)
This method is like a one-time subscribe. |
int |
syncSend(cMsgMessage message,
int timeout)
Method to send a message to the domain server for further distribution and wait for a response from the subdomain handler that got it. |
void |
unsubscribe(java.lang.Object obj)
Method to unsubscribe a previous subscription to receive messages of a subject and type from the domain server. |
Method Detail |
---|
void connect() throws cMsgException
cMsgException
void disconnect() throws cMsgException
cMsgException
boolean isConnected()
void send(cMsgMessage message) throws cMsgException
message
- message
cMsgException
int syncSend(cMsgMessage message, int timeout) throws cMsgException
message
- messagetimeout
- time in milliseconds to wait for a response
cMsgException
void flush(int timeout) throws cMsgException
timeout
- time in milliseconds to wait for completion
cMsgException
cMsgMessage subscribeAndGet(java.lang.String subject, java.lang.String type, int timeout) throws cMsgException, java.util.concurrent.TimeoutException
subject
- subject of message desired from servertype
- type of message desired from servertimeout
- time in milliseconds to wait for a message
cMsgException
java.util.concurrent.TimeoutException
- if timeout occurscMsgMessage sendAndGet(cMsgMessage message, int timeout) throws cMsgException, java.util.concurrent.TimeoutException
send(org.jlab.coda.cMsg.cMsgMessage)
method. The server notes
the fact that a response to it is expected, and sends it to all subscribed to its
subject and type. When a marked response is received from a client, it sends that
first response back to the original sender regardless of its subject or type.
The response may be null.
message
- message sent to servertimeout
- time in milliseconds to wait for a reponse message
cMsgException
java.util.concurrent.TimeoutException
- if timeout occursjava.lang.Object subscribe(java.lang.String subject, java.lang.String type, cMsgCallbackInterface cb, java.lang.Object userObj) throws cMsgException
subject
- message subjecttype
- message typecb
- callback object whose single method is called upon receiving a message
of subject and typeuserObj
- any user-supplied object to be given to the callback method as an argument
cMsgException
void unsubscribe(java.lang.Object obj) throws cMsgException
obj
- the object "handle" returned from a subscribe call
cMsgException
cMsgMessage monitor(java.lang.String command) throws cMsgException
command
- directive for monitoring process
cMsgException
void start()
void stop()
void shutdownClients(java.lang.String client, boolean includeMe) throws cMsgException
client
- client(s) to be shutdownincludeMe
- if true, it is permissible to shutdown calling client
cMsgException
void shutdownServers(java.lang.String server, boolean includeMyServer) throws cMsgException
server
- server(s) to be shutdownincludeMyServer
- if true, it is permissible to shutdown calling client's
cMsg server
cMsgException
void setShutdownHandler(cMsgShutdownHandlerInterface handler)
handler
- shutdown handlercMsgShutdownHandlerInterface getShutdownHandler()
java.lang.String getDomain()
java.lang.String getName()
void setName(java.lang.String name)
name
- name of clientjava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- description of clientjava.lang.String getUDL()
void setUDL(java.lang.String UDL)
UDL
- UDL of client UDLjava.lang.String getUDLRemainder()
void setUDLRemainder(java.lang.String UDLRemainder)
UDLRemainder
- UDL remainder of client UDLjava.lang.String getHost()
java.lang.String getString()
boolean isReceiving()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |