rtcpool.signalling

Transcievers

Transceivers are direct interfaces to a sender/receiver. They are simply a way to standardize different methods of sending and receiving data

class transceiver()

Base class for transceivers.

transceiver.close()

Closes the transceiver.

transceiver.send(msg_type, msg_data)

Sends a message with the given type and data.

Arguments
  • msg_type (string()) – The message type.

  • msg_data (Object()) – The message data.

class sio_transceiver(sockio)

socket.io transceiver class.

Create a socket.io transceiver.

sio_transceiver.send(msg_type, data)
class websocket_transceiver(websocket)

Signalling

Signalling classes are the actual signal senders/handlers that are used by Pool() to negotiate the RTC connections.

class signalling(transceiver)

Represents a signalling channel through which RTC negotiations occur.

Create a signalling channel that translates raw events to signalling-friendly events and sends messages during RTC negotiation.

Arguments
  • transceiver (Object()) – An object that extends EventTarget, and receives signalling messages from the server which it dispatches as events to itself.

class socketio(io)

socket.io signalling class.

Create a socketio signalling channel.

Arguments
  • io (Object()) – The connection returned by io()

class websocket(socket)

Raw WebSocket signalling channel.

Create a raw WebSocket signalling channel.

Arguments
  • socket (WebSocket()) – A WebSocket.