Home Manual Reference Source Repository
import Channel from 'netflux/src/Channel.js'
public class | source

Channel

Wrapper class for RTCDataChannel and WebSocket.

Constructor Summary

Public Constructor
public

constructor(channel: WebSocket | RTCDataChannel, webChannel: WebChannel, peerId: number)

Creates a channel from existing RTCDataChannel or WebSocket.

Member Summary

Public Members
public set

onClose(handler: function(message: CloseEvent)): *

public set

onError(handler: function(message: Event)): *

public set

onMessage(handler: function(msg: ArrayBuffer)): *

public

Identifier of the peer who is at the other end of this channel

public

Send message.

public

The WebChannel which this channel belongs to.

Method Summary

Public Methods
public
public

close()

Close the channel.

public

Public Constructors

public constructor(channel: WebSocket | RTCDataChannel, webChannel: WebChannel, peerId: number) source

Creates a channel from existing RTCDataChannel or WebSocket.

Params:

NameTypeAttributeDescription
channel WebSocket | RTCDataChannel

Data channel or web socket

webChannel WebChannel

The WebChannel this channel will be part of

peerId number

Identifier of the peer who is at the other end of this channel

Public Members

public set onClose(handler: function(message: CloseEvent)): * source

public set onError(handler: function(message: Event)): * source

public set onMessage(handler: function(msg: ArrayBuffer)): * source

public peerId: WebChannel source

Identifier of the peer who is at the other end of this channel

public send: function(message: ArrayBuffer) source

Send message.

public webChannel: WebChannel source

The WebChannel which this channel belongs to.

Public Methods

public clearHandlers() source

public close() source

Close the channel.

public isOpen(): boolean source

Return:

boolean