Membrane.ICE.Handshake behaviour (Membrane ICE plugin v0.5.0) View Source

Behaviour that specifies functions that have to be implemented in order to perform handshake after establishing ICE connection.

One instance of this module is responsible for performing handshake only for one component.

Link to this section Summary

Types

init_notification()

Notification sent to pipeline after executing init/1 function on handshake module

state()

It is any type that user want it to be passed to other functions of this behaviour.

t()

Callbacks

connection_ready(state)

Called only once when component changes state to READY i.e. it is able to receive and send data.

init(id, parent, opts)

Called only once at Sink/Source preparation.

is_hsk_packet(data, state)

Determines if given data should be treated as handshake packet and passed to process/2.

process(data, state)

Called each time remote data arrives.

stop(state)

Called once component is no longer needed and should cleanup resources.

Link to this section Types

init_notification()

Specs

init_notification() ::
  {:handshake_init_data, component_id :: non_neg_integer(), init_data :: any()}

Notification sent to pipeline after executing init/1 function on handshake module

state()

Specs

state() :: term()

It is any type that user want it to be passed to other functions of this behaviour.

t()

Specs

t() :: module()

Link to this section Callbacks

connection_ready(state)

Specs

connection_ready(state :: state()) :: :ok | {:ok, packets :: binary()}

Called only once when component changes state to READY i.e. it is able to receive and send data.

It is a good place to start your handshake.

init(id, parent, opts)

Specs

init(id :: pos_integer(), parent :: pid(), opts :: list()) ::
  {:ok, init_data :: any(), state()} | {:finished, init_data :: any()}

Called only once at Sink/Source preparation.

opts - options specified in handshake_opts option in Sink/Source init_data - any data that will be fired as a notification to pipeline. Notification will be of type init_notification/0 state - state that will be passed to other functions id - id assigned by ICE plugin. It corresponds to component_id. Has to be used for retransmitting packets

Returning by a peer :finished will mark handshake as finished.

is_hsk_packet(data, state)

Specs

is_hsk_packet(data :: binary(), state :: state()) :: boolean()

Determines if given data should be treated as handshake packet and passed to process/2.

process(data, state)

Specs

process(data :: binary(), state :: state()) ::
  :ok
  | {:ok, packets :: binary()}
  | {:handshake_packets, packets :: binary()}
  | {:handshake_finished, hsk_data :: any()}
  | {:handshake_finished, hsk_data :: any(), packets :: binary()}
  | {:connection_closed, reason :: atom()}

Called each time remote data arrives.

If there is a need to retransmit some data send message {:retransmit, id, data}. id is id assigned by ICE in init/3 function.

stop(state)

Specs

stop(state :: state()) :: :ok

Called once component is no longer needed and should cleanup resources.