package org.astrogrid.samp.client; /** * Defines an object that can be used to register with a running SAMP hub. * Registration takes the form of providing a connection object which * a client can use to perform further hub interactions. * Client-side implementations will take care of communications, * mapping between profile-specific transport mechanisms and the * methods of the generated {@link HubConnection} objects. * *
The usual way for a prospective SAMP client to obtain an instance of * this class is by using {@link DefaultClientProfile#getProfile}. * *
This interface is so-named partly for historical reasons; * "HubConnectionFactory" might have been more appropriate. * * @author Mark Taylor * @since 15 Jul 2008 */ public interface ClientProfile { /** * Attempts to register with a SAMP hub and return a corresponding * connection object. Some profile-specific hub discovery mechanism * is used to locate the hub. * If no hub is running, null will normally be returned. * * @return hub connection representing a new registration, or null * @throws SampException in case of some unexpected error */ HubConnection register() throws SampException; /** * Indicates whether a hub contactable by this profile appears to be * running. This is intended to execute reasonably quickly. * It should not go as far as registering. * * @return true iff it looks like a hub is running */ boolean isHubRunning(); }