WebSocket - WebSocket connection¶

[DEPRECATED] Provides access API for WebSocket connections.(This is the old API that provides real-time connectivity. Please refer to iSCP - RealtimeAPI for the latest API.)

Request Methods¶

Warning

Be sure to create the access object using connect_websocket() on client.

client = intdash.Client(...)
conn = client.connect_websocket()

class WebSocketConn(...)[source]¶

An object that represents a WebSocket connection.

close()[source]¶: Closes the WebSocket connection.

open_downstreams(specs, callbacks)[source]¶

Opens a downstream according to the specified downstream specifications.

Parameters

specs (list[DownstreamSpec]) – List of downstream specifications
callbacks (list[func]) – Callback function that is called when processing the retrieved Unit

open_upstreams(specs, iterators, marker_interval=3)[source]¶

Opens an upstream according to the specified upstream specifications.

Parameters

specs (list[UpstreamSpec]) – List of upstream specifications
iterators (list[iter]) – Iterator to be called to generate Units
marker_interval (int) – Marker interval in seconds

Request Params¶

class DownstreamSpec(...)[source]¶

An object that represents downstream specifications.

src_edge_uuid¶

Source edge UUID

Type: str

filters¶

List of data filters

Type: list[DataFilter]

dst_edge_uuid¶

Destination edge UUID

Type: str

class DataFilter(...)[source]¶

An object that represents a data filter.

data_type¶

data type

Type: DataType

channel¶

Channel number

Type: int

data_id¶

Data ID

Type: str

class UpstreamSpec(...)[source]¶

An object that represents upstream specifications.

src_edge_uuid¶

Source edge UUID

Type: str

dst_edge_uuids¶

List of destination edge UUIDs

Type: list[str]

resend¶

Resend flag

Type: bool

store¶

Persistence flag

Type: bool

measurement_uuid¶

Measurement UUID

Type: str