Class SAMPHubProxy

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

(inherited documentation)

Testing method to verify the proxy connection with a running Hub.

Returns: boolean

return True if the proxy is connected to a Hub, False otherwise

Return a dictionary containing the lock-file contents of all the currently running hubs (single and/or multiple mode). The dictionary format is:

{<lock-file>: {<token-name>: <token-string>, ...}, ...}

where <lock-file> is the lock-file name, <token-name> and <token-string> are the lock-file tokens (name and content).

Returns: dictionary

the lock-file contents of all the currently running hubs.

Connect to the current SAMP Hub. If a SAMP Hub is not running or refuses the connection, then a SAMPHubError is raised.

Parameters:

• hub_params (dictionary) - Optional dictionary containig the lock-file content of the Hub with which to connect. This dictionary has the form {<token-name>: <token-string>, ...}.
• user (string) - In case of Basic Authenticated connections, user specifies the user name.
• password (string) - In case of Basic Authenticated connections, password specifies the user password.
• key_file (string) - Set the file containing the private key for SSL connections. If the certificate file (certfile) contains the private key, then keyfile can be omitted.
• cert_file (string) - Specify the file which contains a certificate to be used to identify the local side of the secure connection.
• cert_reqs (int) - The parameter cert_reqs specifies 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 (string) - The ca_certs file contains a set of concatenated "Certification Authority" certificates, which are used to validate the certificate passed from the server end of the connection.
• ssl_version (int) - The ssl_version option specifies 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 ssl.PROTOCOL_SSLv3. This version provides the most compatibility with other versions server side. Other SSL protocol versions are: ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23 and ssl.PROTOCOL_TLSv1.

Proxy to callAndWait SAMP Hub method. If timeout expires a SAMPProxyError instance is raised.