astro py:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- Astropy v1.1.1 »
- Virtual Observatory Access (`astropy.vo`) »
- SAMP (Simple Application Messaging Protocol (`astropy.vo.samp`) »
- SAMPHubProxy

# SAMPHubProxy

class `astropy.vo.samp.``SAMPHubProxy`

  Bases: `object`

  Proxy class to simplify the client interaction with a SAMP hub (via the standard profile).

  Attributes Summary

  `is_connected` | Whether the hub proxy is currently connected to a hub.

  Methods Summary

  `call`(private_key, recipient_id, msg_tag, message) | Proxy to `call` SAMP Hub method.
  `call_all`(private_key, msg_tag, message) | Proxy to `callAll` SAMP Hub method.
  `call_and_wait`(private_key, recipient_id, ...) | Proxy to `callAndWait` SAMP Hub method.
  `connect`([hub, hub_params, key_file, ...]) | Connect to the current SAMP Hub.
  `declare_metadata`(private_key, metadata) | Proxy to `declareMetadata` SAMP Hub method.
  `declare_subscriptions`(private_key, subscriptions) | Proxy to `declareSubscriptions` SAMP Hub method.
  `disconnect`() | Disconnect from the current SAMP Hub.
  `get_metadata`(private_key, client_id) | Proxy to `getMetadata` SAMP Hub method.
  `get_registered_clients`(private_key) | Proxy to `getRegisteredClients` SAMP Hub method.
  `get_subscribed_clients`(private_key, mtype) | Proxy to `getSubscribedClients` SAMP Hub method.
  `get_subscriptions`(private_key, client_id) | Proxy to `getSubscriptions` SAMP Hub method.
  `notify`(private_key, recipient_id, message) | Proxy to `notify` SAMP Hub method.
  `notify_all`(private_key, message) | Proxy to `notifyAll` SAMP Hub method.
  `ping`() | Proxy to `ping` SAMP Hub method (Standard Profile only).
  `register`(secret) | Proxy to `register` SAMP Hub method.
  `reply`(private_key, msg_id, response) | Proxy to `reply` SAMP Hub method.
  `server_close`() |
  `set_xmlrpc_callback`(private_key, xmlrpc_addr) | Proxy to `setXmlrpcCallback` SAMP Hub method (Standard Profile only).
  `unregister`(private_key) | Proxy to `unregister` SAMP Hub method.

  Attributes Documentation

  `is_connected`

    Whether the hub proxy is currently connected to a hub.

  Methods Documentation

  `call`(private_key, recipient_id, msg_tag, message)

    Proxy to `call` SAMP Hub method.

  `call_all`(private_key, msg_tag, message)

    Proxy to `callAll` SAMP Hub method.

  `call_and_wait`(private_key, recipient_id, message, timeout)

    Proxy to `callAndWait` SAMP Hub method.

  `connect`(hub=None, hub_params=None, key_file=None, cert_file=None, cert_reqs=0, ca_certs=None, ssl_version=None, pool_size=20)

    Connect to the current SAMP Hub.

    Parameters:

    hub : `SAMPHubServer`, optional

    > The hub to connect to.

    hub_params : dict, optional

    > Optional dictionary containing the lock-file content of the Hub with which to connect. This dictionary has the form `{<token-name>: <token-string>, ...}`.

    key_file : str, optional

    > The path to a file containing the private key for SSL connections. If the certificate file (`cert_file`) contains the private key, then `key_file` can be omitted.

    cert_file : str, optional

    > The path to a file which contains a certificate to be used to identify the local side of the secure connection.

    cert_reqs : int, optional

    > Whether a certificate is required from the server side of the connection, and whether it will be validated if provided. It must be one of the three values `ssl.CERT_NONE` (certificates ignored), `ssl.CERT_OPTIONAL` (not required, but validated if provided), or `ssl.CERT_REQUIRED` (required and validated). If the value of this parameter is not `ssl.CERT_NONE`, then the `ca_certs` parameter must point to a file of CA certificates.

    ca_certs : str, optional

    > The path to a file containing a set of concatenated “Certification Authority” certificates, which are used to validate the certificate passed from the Hub end of the connection.

    ssl_version : int, optional

    > Which version of the SSL protocol to use. Typically, the server chooses a particular protocol version, and the client must adapt to the server’s choice. Most of the versions are not interoperable with the other versions. If not specified, the default SSL version is taken from the default in the installed version of the Python standard `ssl` library. See the `ssl` documentation for more information.

    pool_size : int, optional

    > The number of socket connections opened to communicate with the Hub.

  `declare_metadata`(private_key, metadata)

    Proxy to `declareMetadata` SAMP Hub method.

  `declare_subscriptions`(private_key, subscriptions)

    Proxy to `declareSubscriptions` SAMP Hub method.

  `disconnect`()

    Disconnect from the current SAMP Hub.

  `get_metadata`(private_key, client_id)

    Proxy to `getMetadata` SAMP Hub method.

  `get_registered_clients`(private_key)

    Proxy to `getRegisteredClients` SAMP Hub method.

  `get_subscribed_clients`(private_key, mtype)

    Proxy to `getSubscribedClients` SAMP Hub method.

  `get_subscriptions`(private_key, client_id)

    Proxy to `getSubscriptions` SAMP Hub method.

  `notify`(private_key, recipient_id, message)

    Proxy to `notify` SAMP Hub method.

  `notify_all`(private_key, message)

    Proxy to `notifyAll` SAMP Hub method.

  `ping`()

    Proxy to `ping` SAMP Hub method (Standard Profile only).

  `register`(secret)

    Proxy to `register` SAMP Hub method.

  `reply`(private_key, msg_id, response)

    Proxy to `reply` SAMP Hub method.

  `server_close`()
  `set_xmlrpc_callback`(private_key, xmlrpc_addr)

    Proxy to `setXmlrpcCallback` SAMP Hub method (Standard Profile only).

  `unregister`(private_key)

    Proxy to `unregister` SAMP Hub method.