Inheritance diagram for opcua.client.client.Client:
Public Member Functions | |
| def | __enter__ (self) |
| def | __exit__ (self, exc_type, exc_value, traceback) |
| def | __init__ (self, url, timeout=4) |
| def | activate_session (self, username=None, password=None, certificate=None) |
| def | close_secure_channel (self) |
| def | close_session (self) |
| def | connect (self) |
| def | connect_and_find_servers (self) |
| def | connect_and_find_servers_on_network (self) |
| def | connect_and_get_server_endpoints (self) |
| def | connect_socket (self) |
| def | create_session (self) |
| def | create_subscription (self, period, handler) |
| def | delete_nodes (self, nodes, recursive=False) |
| def | disconnect (self) |
| def | disconnect_socket (self) |
| def | find_servers (self, uris=None) |
| def | find_servers_on_network (self) |
| def | get_endpoints (self) |
| def | get_namespace_array (self) |
| def | get_namespace_index (self, uri) |
| def | get_node (self, nodeid) |
| def | get_objects_node (self) |
| def | get_root_node (self) |
| def | get_server_node (self) |
| def | load_client_certificate (self, path) |
| def | load_private_key (self, path) |
| def | open_secure_channel (self, renew=False) |
| def | register_server (self, server, discovery_configuration=None) |
| def | send_hello (self) |
| def | server_policy_id (self, token_type, default) |
| def | server_policy_uri (self, token_type) |
| def | set_security (self, policy, certificate_path, private_key_path, server_certificate_path=None, mode=ua.MessageSecurityMode.SignAndEncrypt) |
| def | set_security_string (self, string) |
Static Public Member Functions | |
| def | find_endpoint (endpoints, security_mode, policy_uri) |
Private Member Functions | |
| def | _add_anonymous_auth (self, params) |
| def | _add_certificate_auth (self, params, certificate, challenge) |
| def | _add_user_auth (self, params, username, password) |
| def | _encrypt_password (self, password, policy_uri) |
Private Attributes | |
| _policy_ids | |
| _server_nonce | |
| _session_counter | |
Detailed Description
High level client to connect to an OPC-UA server. This class makes it easy to connect and browse address space. It attemps to expose as much functionality as possible but if you want more flexibility it is possible and adviced to use UaClient object, available as self.uaclient which offers the raw OPC-UA services interface.
Constructor & Destructor Documentation
| def opcua.client.client.Client.__init__ | ( | self, | |
| url, | |||
timeout = 4 |
|||
| ) |
Member Function Documentation
| def opcua.client.client.Client.__exit__ | ( | self, | |
| exc_type, | |||
| exc_value, | |||
| traceback | |||
| ) |
|
private |
|
private |
|
private |
|
private |
| def opcua.client.client.Client.activate_session | ( | self, | |
username = None, |
|||
password = None, |
|||
certificate = None |
|||
| ) |
| def opcua.client.client.Client.close_secure_channel | ( | self | ) |
| def opcua.client.client.Client.close_session | ( | self | ) |
| def opcua.client.client.Client.connect | ( | self | ) |
| def opcua.client.client.Client.connect_and_find_servers | ( | self | ) |
| def opcua.client.client.Client.connect_and_find_servers_on_network | ( | self | ) |
| def opcua.client.client.Client.connect_and_get_server_endpoints | ( | self | ) |
| def opcua.client.client.Client.connect_socket | ( | self | ) |
| def opcua.client.client.Client.create_session | ( | self | ) |
| def opcua.client.client.Client.create_subscription | ( | self, | |
| period, | |||
| handler | |||
| ) |
Create a subscription. returns a Subscription object which allow to subscribe to events or data on server handler argument is a class with data_change and/or event methods. period argument is either a publishing interval in seconds or a CreateSubscriptionParameters instance. The second option should be used, if the opcua-server has problems with the default options. These methods will be called when notfication from server are received. See example-client.py. Do not do expensive/slow or network operation from these methods since they are called directly from receiving thread. This is a design choice, start another thread if you need to do such a thing.
| def opcua.client.client.Client.delete_nodes | ( | self, | |
| nodes, | |||
recursive = False |
|||
| ) |
| def opcua.client.client.Client.disconnect | ( | self | ) |
|
static |
| def opcua.client.client.Client.find_servers | ( | self, | |
uris = None |
|||
| ) |
| def opcua.client.client.Client.find_servers_on_network | ( | self | ) |
| def opcua.client.client.Client.get_namespace_array | ( | self | ) |
| def opcua.client.client.Client.get_namespace_index | ( | self, | |
| uri | |||
| ) |
| def opcua.client.client.Client.get_node | ( | self, | |
| nodeid | |||
| ) |
| def opcua.client.client.Client.load_client_certificate | ( | self, | |
| path | |||
| ) |
| def opcua.client.client.Client.load_private_key | ( | self, | |
| path | |||
| ) |
| def opcua.client.client.Client.open_secure_channel | ( | self, | |
renew = False |
|||
| ) |
| def opcua.client.client.Client.register_server | ( | self, | |
| server, | |||
discovery_configuration = None |
|||
| ) |
| def opcua.client.client.Client.send_hello | ( | self | ) |
| def opcua.client.client.Client.server_policy_id | ( | self, | |
| token_type, | |||
| default | |||
| ) |
| def opcua.client.client.Client.server_policy_uri | ( | self, | |
| token_type | |||
| ) |
| def opcua.client.client.Client.set_security | ( | self, | |
| policy, | |||
| certificate_path, | |||
| private_key_path, | |||
server_certificate_path = None, |
|||
mode = ua.MessageSecurityMode.SignAndEncrypt |
|||
| ) |
| def opcua.client.client.Client.set_security_string | ( | self, | |
| string | |||
| ) |
Set SecureConnection mode. String format:
Policy,Mode,certificate,private_key[,server_private_key]
where Policy is Basic128Rsa15 or Basic256,
Mode is Sign or SignAndEncrypt
certificate, private_key and server_private_key are
paths to .pem or .der files
Call this before connect()
Member Data Documentation
The documentation for this class was generated from the following file: