import ChannelBuilderService from 'netflux/src/service/ChannelBuilderService.js'

public class | source

ChannelBuilderService

Extends:

service/Service~Service → ChannelBuilderService

It is responsible to build a channel between two peers with a help of WebSocketService and WebRTCService. Its algorithm determine which channel (socket or dataChannel) should be created based on the services availability and peers' preferences.

Constructor Summary

Public Constructor
public	constructor(id: number)

Method Summary

Public Methods
public	availableConnectors(wc: WebChannel): {listenOn: string, connectors: number[]}
public	connectTo(wc: WebChannel, id: number): Promise<Channel, string> Establish a channel with the peer identified by `id`.
public	onChannel(wc: WebChannel, channel: WebSocket \| RTCDataChannel, senderId: number)
public	onMessage(channel: Channel, senderId: number, recepientId: number, msg: Object)

Public Constructors

public constructor(id: number) source

Params:

Name	Type	Attribute	Description
id	number		Service identifier

Public Methods

public availableConnectors(wc: WebChannel): {listenOn: string, connectors: number[]} source

Params:

Name	Type	Attribute	Description
wc	WebChannel

Return:

{listenOn: string, connectors: number[]}

public connectTo(wc: WebChannel, id: number): Promise<Channel, string> source

Establish a channel with the peer identified by id.

Params:

Name	Type	Attribute	Description
wc	WebChannel
id	number

Return:

Promise<Channel, string>

public onChannel(wc: WebChannel, channel: WebSocket | RTCDataChannel, senderId: number) source

Params:

Name	Type	Attribute	Description
wc	WebChannel
channel	WebSocket \| RTCDataChannel
senderId	number

public onMessage(channel: Channel, senderId: number, recepientId: number, msg: Object) source

Params:

Name	Type	Attribute	Description
channel	Channel
senderId	number
recepientId	number
msg	Object