Package org.astrogrid.samp.client

Interface CallableClient

All Known Implementing Classes:

Calculator

public interface CallableClient

Defines callbacks which the hub can make on a callable client.

Since:

16 Jul 2008

Author:

Mark Taylor

Method Summary

Modifier and Type	Method	Description
void	receiveCall(java.lang.String senderId, java.lang.String msgId, Message message)	Receives a message for which a response is required.
void	receiveNotification(java.lang.String senderId, Message message)	Receives a message for which no response is required.
void	receiveResponse(java.lang.String responderId, java.lang.String msgTag, Response response)	Receives a response to a message previously sent by this client.

Method Detail

receiveNotification

void receiveNotification(java.lang.String senderId,
                         Message message)
                  throws java.lang.Exception

Receives a message for which no response is required.

Parameters:

senderId - public ID of sending client

message - message

Throws:

java.lang.Exception

receiveCall

void receiveCall(java.lang.String senderId,
                 java.lang.String msgId,
                 Message message)
          throws java.lang.Exception

Receives a message for which a response is required. The implementation must take care to call the hub's reply method at some future point.

Parameters:

senderId - public ID of sending client

msgId - message identifier for later use with reply

message - message

Throws:

java.lang.Exception

receiveResponse

void receiveResponse(java.lang.String responderId,
                     java.lang.String msgTag,
                     Response response)
              throws java.lang.Exception

Receives a response to a message previously sent by this client.

Parameters:

responderId - public ID of responding client

msgTag - client-defined tag labelling previously-sent message

response - returned response object

Throws:

java.lang.Exception