Module skyway_webrtc_gateway_api::data

source · [−]

Expand description

/data api bindings

Structs

Query for POST /data/connections

ConnectionQueryOption

Query parameter for POST /data/connections

DataConnectionId

Identifier for DataConnection

DataConnectionIdWrapper

Struct just for adapter to adjust JSON format

DataConnectionStatus

Response from GET /data/connections/{data_cnnection_id}/status

Identifier for source socket of data

Struct just for adapter to adjust JSON format

Query parameter for POST /data/connections

RedirectDataParams

Query for PUT /data/connections

RedirectDataResponse

Response from PUT /data/connections

Enums

DataConnectionEventEnum

Shows DataConnection events.

Functions

close_data_socket

This function let a WebRTC Gateway close a socket to receive media which will be redirected to neighbour peer.

This function let a WebRTC Gateway establish a DataChannel to neighbour

This function let a WebRTC Gateway close a DataChannel

This function get a single event from a WebRTC Gateway.

This function keep listening events from a WebRTC Gateway. It keep accessing event API endpoint until receiving a CLOSE event or HTTP Error Code.

open_data_socket

This function let a WebRTC Gateway open a socket to receive media which will be redirected to neighbour peer.

DataConnection is automatically established when neighbour connect to this side. In that case, the connection doesn’t have source and destination port information. This function set the information.

This function to get status of DataChannel