Package org.astrogrid.samp.xmlrpc
Interface ClientActor
-
- All Known Implementing Classes:
ClientXmlRpcHandler.ClientActorImpl
interface ClientActor
Defines the methods which an XML-RPC callable client must implement.- Since:
- 16 Jul 2008
- Author:
- Mark Taylor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
receiveCall(java.lang.String privateKey, java.lang.String senderId, java.lang.String msgId, java.util.Map msg)
Receives a message for which a response is required.void
receiveNotification(java.lang.String privateKey, java.lang.String senderId, java.util.Map msg)
Receives a message for which no response is required.void
receiveResponse(java.lang.String privateKey, java.lang.String responderId, java.lang.String msgTag, java.util.Map response)
Receives a response to a message previously sent by this client.
-
-
-
Method Detail
-
receiveNotification
void receiveNotification(java.lang.String privateKey, java.lang.String senderId, java.util.Map msg) throws java.lang.Exception
Receives a message for which no response is required.- Parameters:
privateKey
- private key for hub-client communicationsenderId
- public ID of sending clientmsg
- message- Throws:
java.lang.Exception
-
receiveCall
void receiveCall(java.lang.String privateKey, java.lang.String senderId, java.lang.String msgId, java.util.Map msg) throws java.lang.Exception
Receives a message for which a response is required. The implementation must take care to call the hub'sreply
method at some future point.- Parameters:
privateKey
- private key for hub-client communicationsenderId
- public ID of sending clientmsgId
- message identifier for later use with replymsg
- message- Throws:
java.lang.Exception
-
receiveResponse
void receiveResponse(java.lang.String privateKey, java.lang.String responderId, java.lang.String msgTag, java.util.Map response) throws java.lang.Exception
Receives a response to a message previously sent by this client.- Parameters:
privateKey
- private key for hub-client communicationresponderId
- public ID of responding clientmsgTag
- client-defined tag labelling previously-sent messageresponse
- returned response object- Throws:
java.lang.Exception
-
-