Package org.astrogrid.samp.hub
Class BasicHubService
java.lang.Object
org.astrogrid.samp.hub.BasicHubService
- All Implemented Interfaces:
HubService
- Direct Known Subclasses:
GuiHubService
HubService implementation.
- Since:
- 15 Jul 2008
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic int
The maximum timeout for a synchronous call permitted in seconds.static int
The maximum number of concurrently pending synchronous calls. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
Does the work for thecall
method of connections registered with this service.protected Map
Does the work for thecall
method of connections registered with this service.protected Response
callAndWait
(HubClient caller, String recipientId, Map message, int timeout) Does the work for thecallAndWait
method of connections registered with this service.protected HubClient
createClient
(String publicId, ProfileToken ptoken) Factory method used to create all the client objects which will be used by this hub service.protected ClientSet
Factory method used to create the client set used by this hub service.protected HubConnection
createConnection
(HubClient caller) Returns a new HubConnection for use by a given hub client.protected AbstractMessageHandler[]
Constructs a list of MessageHandlers to use for the client provided by the Hub.protected void
declareMetadata
(HubClient caller, Map meta) Does the work for thedeclareMetadata
method of connections registered with this service.protected void
declareSubscriptions
(HubClient caller, Map subscriptions) Does the work for thedeclareSubscriptions
method of connections registered with this service.void
disconnect
(String clientId, String reason) Forcibly disconnects a given client.void
disconnectAll
(ProfileToken profileToken) Forcibly terminates any connections created by a previous call ofHubService.register(org.astrogrid.samp.hub.ProfileToken)
with a particularprofileToken
.Returns the structure which keeps track of registered clients.Returns a comparator which will order client IDs.protected Metadata
getMetadata
(HubClient caller, String clientId) Does the work for thegetMetadata
method of connections registered with this service.protected String[]
getRegisteredClients
(HubClient caller) Does the work for thegetRegisteredClients
method of connections registered with this service.Returns the HubConnection object used by the hub itself to send and receive messages.protected Map
getSubscribedClients
(HubClient caller, String mtype) Does the work for thegetSubscribedClients
method of connections registered with this service.protected Subscriptions
getSubscriptions
(HubClient caller, String clientId) Does the work for thegetSubscriptions
method of connections registered with this service.boolean
Indicates whether this hub service is currently open for operations.protected void
Does the work for thenotify
method of connections registered with this service.protected List
Does the work for thenotifyAll
method of connections registered with this service.register
(ProfileToken ptoken) Creates a new connection to this hub service, thereby initiating a new registered client.protected void
Does the work for thereply
method of connections registered with this service.protected void
setCallable
(HubClient caller, CallableClient callable) Does the work for thesetCallable
method of connections registered with this service.void
shutdown()
Tidies up any resources owned by this object.void
start()
Begin operation.protected void
unregister
(HubClient caller) Does the work for theunregister
method of conections registered with this service.
-
Field Details
-
MAX_TIMEOUT
public static int MAX_TIMEOUTThe maximum timeout for a synchronous call permitted in seconds. Default is 43200 = 12 hours. -
MAX_WAITERS
public static int MAX_WAITERSThe maximum number of concurrently pending synchronous calls. Default is 100.
-
-
Constructor Details
-
BasicHubService
Constructor.- Parameters:
random
- random number generator used for message tags etc
-
-
Method Details
-
start
public void start()Description copied from interface:HubService
Begin operation. TheHubService.register(org.astrogrid.samp.hub.ProfileToken)
method should not be called until the hub has been started.- Specified by:
start
in interfaceHubService
-
createClientSet
Factory method used to create the client set used by this hub service.- Returns:
- client set
-
createClient
Factory method used to create all the client objects which will be used by this hub service.- Parameters:
publicId
- client public IDptoken
- connection source- Returns:
- hub client
-
createHubMessageHandlers
Constructs a list of MessageHandlers to use for the client provided by the Hub.- Returns:
- hub message handler list
-
getIdComparator
Returns a comparator which will order client IDs. The ordering is in creation sequence.- Returns:
- public ID comparator
-
getClientSet
Returns the structure which keeps track of registered clients.- Returns:
- client set
-
register
Description copied from interface:HubService
Creates a new connection to this hub service, thereby initiating a new registered client.It is the responsibility of the returned connection, not the user of that connection, to broadcast the various
samp.hub.event.*
notifications at the appropriate times.Most of the
HubConnection
methods are declared to throwSampException
, however, implementations may throw unchecked exceptions if that is more convenient; users of the connection should be prepared to catch these if they occur.- Specified by:
register
in interfaceHubService
- Parameters:
ptoken
- identifier for the profile acting as gatekeeper for this connection- Returns:
- new hub connection representing registration of a new client
- Throws:
SampException
-
disconnectAll
Description copied from interface:HubService
Forcibly terminates any connections created by a previous call ofHubService.register(org.astrogrid.samp.hub.ProfileToken)
with a particularprofileToken
. Any necessary hub events will be sent.- Specified by:
disconnectAll
in interfaceHubService
- Parameters:
profileToken
- previous argument toregister
-
createConnection
Returns a new HubConnection for use by a given hub client. The instance methods of the returned object delegate to similarly named protected methods of this BasicHubService object. These BasicHubService methods may therefore be overridden to modify the behaviour of such returned connections.- Parameters:
caller
- client requiring a connection- Returns:
- connection whose methods may be called by or on behalf of
caller
-
unregister
Does the work for theunregister
method of conections registered with this service.- Parameters:
caller
- client to unregister- Throws:
SampException
- See Also:
-
setCallable
Does the work for thesetCallable
method of connections registered with this service.- Parameters:
caller
- clientcallable
- callable object- Throws:
SampException
- See Also:
-
declareMetadata
Does the work for thedeclareMetadata
method of connections registered with this service.- Parameters:
caller
- clientmeta
- new metadata for client- Throws:
SampException
- See Also:
-
getMetadata
Does the work for thegetMetadata
method of connections registered with this service.- Parameters:
caller
- calling clientclientId
- id of client being queried- Returns:
- metadata for client
- Throws:
SampException
- See Also:
-
declareSubscriptions
Does the work for thedeclareSubscriptions
method of connections registered with this service.- Parameters:
caller
- clientsubscriptions
- new subscriptions for client- Throws:
SampException
- See Also:
-
getSubscriptions
Does the work for thegetSubscriptions
method of connections registered with this service.- Parameters:
caller
- calling clientclientId
- id of client being queried- Returns:
- subscriptions for client
- Throws:
SampException
- See Also:
-
getRegisteredClients
Does the work for thegetRegisteredClients
method of connections registered with this service.- Parameters:
caller
- calling client- Returns:
- array of registered client IDs excluding
caller
's - Throws:
SampException
- See Also:
-
getSubscribedClients
Does the work for thegetSubscribedClients
method of connections registered with this service.- Parameters:
caller
- calling clientmtype
- message type- Returns:
- map in which the keys are the public IDs of clients
subscribed to
mtype
- Throws:
SampException
- See Also:
-
notify
Does the work for thenotify
method of connections registered with this service.- Parameters:
caller
- calling clientrecipientId
- public ID of client to receive messagemessage
- message- Throws:
SampException
- See Also:
-
call
protected String call(HubClient caller, String recipientId, String msgTag, Map message) throws SampException Does the work for thecall
method of connections registered with this service.- Parameters:
caller
- calling clientrecipientId
- client ID of recipientmsgTag
- message tagmessage
- message- Returns:
- message ID
- Throws:
SampException
- See Also:
-
notifyAll
Does the work for thenotifyAll
method of connections registered with this service.- Parameters:
caller
- calling clientmessage
- message- Returns:
- list of public IDs for clients to which the notify will be sent
- Throws:
SampException
- See Also:
-
callAll
Does the work for thecall
method of connections registered with this service.- Parameters:
caller
- calling clientmsgTag
- message tagmessage
- message- Returns:
- publicId->msgId map for clients to which an attempt to send the call will be made
- Throws:
SampException
- See Also:
-
reply
Does the work for thereply
method of connections registered with this service.- Parameters:
caller
- calling clientmsgIdStr
- message IDresp
- response to forward- Throws:
SampException
- See Also:
-
callAndWait
protected Response callAndWait(HubClient caller, String recipientId, Map message, int timeout) throws SampException Does the work for thecallAndWait
method of connections registered with this service.- Parameters:
caller
- calling clientrecipientId
- client ID of recipientmessage
- messagetimeout
- timeout in seconds- Returns:
- response response
- Throws:
SampException
- See Also:
-
getServiceConnection
Returns the HubConnection object used by the hub itself to send and receive messages. This is the one which apparently sends samp.hub.event.shutdown messages etc.- Returns:
- hub service's own hub connection
-
disconnect
Forcibly disconnects a given client. This call does three things:- sends a
samp.hub.disconnect
message to the client which is about to be ejected, if the client is subscribed to that MType - removes that client from this hub's client set so that any further communication attempts to or from it will fail
- broadcasts a
samp.hub.unregister
message to all remaining clients indicating that the client has disappeared
- Parameters:
clientId
- public-id of client to ejectreason
- short text string indicating reason for ejection
- sends a
-
isHubRunning
public boolean isHubRunning()Description copied from interface:HubService
Indicates whether this hub service is currently open for operations.- Specified by:
isHubRunning
in interfaceHubService
- Returns:
- true iff called between
HubService.start()
andHubService.shutdown()
-
shutdown
public void shutdown()Description copied from interface:HubService
Tidies up any resources owned by this object. Should be called when no longer required.- Specified by:
shutdown
in interfaceHubService
-