StandardHubConnection

java.lang.Object
- org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
- - org.astrogrid.samp.xmlrpc.StandardHubConnection

All Implemented Interfaces:

HubConnection
```
class StandardHubConnection
extends XmlRpcHubConnection
```
HubConnection implementation for the Standard Profile.

Since:

27 Oct 2010

Author:

Mark Taylor

Field Summary

Fields
Modifier and Type Field and Description

private CallableClientServer callableServer_

private java.lang.String clientKey_

private SampXmlRpcServerFactory serverFactory_

Fields
Modifier and Type	Field and Description
`private CallableClientServer`	`callableServer_`
`private java.lang.String`	`clientKey_`
`private SampXmlRpcServerFactory`	`serverFactory_`

Constructor Summary

Constructors
Constructor and Description
`StandardHubConnection(SampXmlRpcClient xClient, SampXmlRpcServerFactory serverFactory, java.lang.String secret)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getClientKey()` Returns an object which is used as the first argument of most XML-RPC calls to the hub.
`void`	`setCallable(CallableClient callable)` Tells the hub how it can perform callbacks on the client by providing a CallableClient object.
`void`	`unregister()` Unregisters the client and terminates this connection.

Methods inherited from class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection
call, callAll, callAndWait, declareMetadata, declareSubscriptions, exec, finalize, getMetadata, getRegInfo, getRegisteredClients, getSubscribedClients, getSubscriptions, notify, notifyAll, ping, rawExec, reply

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serverFactory_
```
private final SampXmlRpcServerFactory serverFactory_
```
  - clientKey_
```
private final java.lang.String clientKey_
```
  - callableServer_
```
private CallableClientServer callableServer_
```
- Constructor Detail
  - StandardHubConnection
```
public StandardHubConnection(SampXmlRpcClient xClient,
                             SampXmlRpcServerFactory serverFactory,
                             java.lang.String secret)
                      throws SampException
```
    Constructor.
    
    Parameters:
    
    xClient - XML-RPC client
    
    serverFactory - XML-RPC server factory implementation
    
    secret - samp.secret registration password
    
    Throws:
    
    SampException
- Method Detail
  - getClientKey
```
public java.lang.Object getClientKey()
```
    Description copied from class: XmlRpcHubConnection
    
    Returns an object which is used as the first argument of most XML-RPC calls to the hub.
    
    Specified by:
    
    getClientKey in class XmlRpcHubConnection
    
    Returns:
    
    SAMP-friendly object to identify this client
  - setCallable
```
public void setCallable(CallableClient callable)
                 throws SampException
```
    Description copied from interface: HubConnection
    
    Tells the hub how it can perform callbacks on the client by providing a CallableClient object. This is required before the client can declare subscriptions or make asynchronous calls.
    
    Parameters:
    
    callable - callable client
    
    Throws:
    
    SampException
  - unregister
```
public void unregister()
                throws SampException
```
    Description copied from interface: HubConnection
    
    Unregisters the client and terminates this connection.
    
    Specified by:
    
    unregister in interface HubConnection
    
    Overrides:
    
    unregister in class XmlRpcHubConnection
    
    Throws:
    
    SampException

Class StandardHubConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.astrogrid.samp.xmlrpc.XmlRpcHubConnection

Methods inherited from class java.lang.Object

Field Detail

serverFactory_

clientKey_

callableServer_

Constructor Detail

StandardHubConnection

Method Detail

getClientKey

setCallable

unregister