interface HubActor
Modifier and Type | Method and Description |
---|---|
java.lang.String |
call(java.lang.String privateKey,
java.lang.String recipientId,
java.lang.String msgTag,
java.util.Map msg)
Sends a message to a given client expecting a response.
|
java.util.Map |
callAll(java.lang.String privateKey,
java.lang.String msgTag,
java.util.Map msg)
Sends a message to all subscribed clients expecting responses.
|
java.util.Map |
callAndWait(java.lang.String privateKey,
java.lang.String recipientId,
java.util.Map msg,
java.lang.String timeout)
Sends a message synchronously to a client.
|
void |
declareMetadata(java.lang.String privateKey,
java.util.Map meta)
Declares metadata for the calling client.
|
void |
declareSubscriptions(java.lang.String privateKey,
java.util.Map subs)
Declares subscription information for the calling client.
|
java.util.Map |
getMetadata(java.lang.String privateKey,
java.lang.String clientId)
Returns metadata for a given client.
|
java.util.List |
getRegisteredClients(java.lang.String privateKey)
Returns a list of the public-ids of all currently registered clients.
|
java.util.Map |
getSubscribedClients(java.lang.String privateKey,
java.lang.String mtype)
Returns a map of the clients subscribed to a given MType.
|
java.util.Map |
getSubscriptions(java.lang.String privateKey,
java.lang.String clientId)
Returns subscriptions for a given client.
|
void |
notify(java.lang.String privateKey,
java.lang.String recipientId,
java.util.Map msg)
Sends a message to a given client without wanting a response.
|
java.util.List |
notifyAll(java.lang.String privateKey,
java.util.Map msg)
Sends a message to all subscribed clients without wanting a response.
|
void |
ping()
Throws an exception if service is not operating.
|
void |
ping(java.lang.String privateKey)
Throws an exception if service is not operating.
|
java.util.Map |
register(java.lang.String secret)
Registers a new client and returns a map with registration information.
|
void |
reply(java.lang.String privateKey,
java.lang.String msgId,
java.util.Map response)
Responds to a previously sent message.
|
void |
setXmlrpcCallback(java.lang.String privateKey,
java.lang.String url)
Sets the XML-RPC URL to use for callbacks for a callable client.
|
void |
unregister(java.lang.String privateKey)
Unregisters a registered client.
|
void ping() throws SampException
SampException
void ping(java.lang.String privateKey) throws SampException
privateKey
- ignoredSampException
java.util.Map register(java.lang.String secret) throws SampException
secret
- registration passwordRegInfo
-like map.SampException
void unregister(java.lang.String privateKey) throws SampException
privateKey
- calling client private keySampException
void setXmlrpcCallback(java.lang.String privateKey, java.lang.String url) throws SampException
privateKey
- calling client private keyurl
- XML-RPC endpoint for client API callbacksSampException
void declareMetadata(java.lang.String privateKey, java.util.Map meta) throws SampException
privateKey
- calling client private keymeta
- Metadata
-like mapSampException
java.util.Map getMetadata(java.lang.String privateKey, java.lang.String clientId) throws SampException
privateKey
- calling client private keyclientId
- public ID for client whose metadata is requiredMetadata
-like mapSampException
void declareSubscriptions(java.lang.String privateKey, java.util.Map subs) throws SampException
privateKey
- calling client private keysubs
- Subscriptions
-like mapSampException
java.util.Map getSubscriptions(java.lang.String privateKey, java.lang.String clientId) throws SampException
privateKey
- calling client private keySubscriptions
-like mapSampException
java.util.List getRegisteredClients(java.lang.String privateKey) throws SampException
privateKey
- calling client private keySampException
java.util.Map getSubscribedClients(java.lang.String privateKey, java.lang.String mtype) throws SampException
privateKey
- calling client private keymtype
- MType of interestmtype
SampException
void notify(java.lang.String privateKey, java.lang.String recipientId, java.util.Map msg) throws SampException
privateKey
- calling client private keyrecipientId
- public-id of client to receive messagemsg
- Message
-like mapSampException
java.util.List notifyAll(java.lang.String privateKey, java.util.Map msg) throws SampException
privateKey
- calling client private keymsg
- Message
-like mapSampException
java.lang.String call(java.lang.String privateKey, java.lang.String recipientId, java.lang.String msgTag, java.util.Map msg) throws SampException
privateKey
- calling client private keyrecipientId
- public-id of client to receive messagemsgTag
- arbitrary string tagging this message for caller's
benefitmsg
- Message
-like mapSampException
java.util.Map callAll(java.lang.String privateKey, java.lang.String msgTag, java.util.Map msg) throws SampException
privateKey
- calling client private keymsgTag
- arbitrary string tagging this message for caller's
benefitmsg
- Message
-like mapSampException
java.util.Map callAndWait(java.lang.String privateKey, java.lang.String recipientId, java.util.Map msg, java.lang.String timeout) throws SampException
privateKey
- calling client private keyrecipientId
- public-id of client to receive messagemsg
- Message
-like maptimeout
- timeout in seconds encoded as a SAMP intResponse
-like mapSampException
void reply(java.lang.String privateKey, java.lang.String msgId, java.util.Map response) throws SampException
privateKey
- calling client private keymsgId
- ID associated with earlier sendresponse
- Response
-like mapSampException