Class SignalingChannel

A class for signaling channel for two peers to exchange messages. Used during the ICE framework.

Hierarchy

SignalingChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SignalingChannel(socket: RoomServer, signalingChannel: string): SignalingChannel

- Defined in Peer2Peer/SignalingChannel.ts:10
Parameters
- socket: RoomServer
- signalingChannel: string
Returns SignalingChannel

Properties

onMSG

onMSG: function

Function to do when receiving a message through the channel.

Type declaration

- (msg: any): void
- Parameters
  - msg: any
  Returns void

signalingChannel

signalingChannel: string

Id of the channel hosted on the room server.

socket

socket: RoomServer

The room server where the channel is hosted.

Methods

close

close(): void

- Defined in Peer2Peer/SignalingChannel.ts:50
Closes the signaling channel.

Returns void

send

send(msg: any): void

- Defined in Peer2Peer/SignalingChannel.ts:23
Sends a message through the signaling channel.

Parameters
- msg: any
  
  Message to send.
Returns void

setOnMSG

setOnMSG(f: function): void

- Defined in Peer2Peer/SignalingChannel.ts:43
Sets onMsg function.

Parameters
- f: function
  
  Function to use as onMsg.
  - - (msg: any): void
    - Parameters
      - msg: any
      Returns void
Returns void

Private setupOnMsg

setupOnMsg(): void

- Defined in Peer2Peer/SignalingChannel.ts:30
Setups what to do when receiving a message through the signalingChannel.

Returns void

Generated using TypeDoc