WebSocket - WebSocket connection¶
Provides access API for WebSocket connections.
Deprecated since version 2.0.0: Use iSCP - RealtimeAPI instead.
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.
- 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