Client Interface
- class client.Client
Bases:
objectThis class is used to start a capture client on a local or remote system.
A local client is typically used with Exostiv Probe. To start a local client call ‘start_local_client’.
A remote client is typically used with Exostiv Blade. To start a remove client call ‘start_start_remote_client’.
Once the client is running, use ‘get_python_intf’ to retrieve a reference to the client’s Python interface.
A connection to a client is automatically closed when an instance of the Client class is destroyed.
- get_python_intf()
Returns a reference to the Python interface of the capture client.
- Returns
- HostPythonIntf
Reference to the HostPythonIntf class.
- start_local_client(port_nr=7003, headless=False)
Starts a capture client on the local system.
- Parameters
- port_nrint, optional
A TCP port number can optionally be specified. Note that this is usually not needed, unless the port is already in use. By default 7003.
- headlessbool, optional
The client GUI is hiddedn when True, by default False.
- Returns
- int
0 on success, error code otherwise.
- start_remote_client(ip_address, user_name=None, user_password=None)
Starts a capture client on a remote system, typically Exostiv Blade.
- Parameters
- ip_address: str
IP address of the target system.
- user_name; str, optional
Username as defined on the remote system. Use together with ‘user_password’. By default None.
- user_password: str, optional
Password as defined on the remote system. Use together with ‘user_name’. By default None.
- Returns
- int
0 on success, error code otherwise.