Home Manual Reference Source Repository

References

Class Summary

Static Public Class Summary
public	BotServer BotServer can listen on web socket.
public	Channel Wrapper class for `RTCDataChannel` and `WebSocket`.
public	ChannelBuilderService It is responsible to build a channel between two peers with a help of `WebSocketService` and `WebRTCService`.
public	FullyConnectedService Fully connected web channel manager.
public	MessageBuilderService Message builder service is responsible to build messages to send them over the `WebChannel` and treat messages received by the `WebChannel`.
public	Service Abstract class which each service should inherit.
public	ServiceFactory It is a factory helper class which is responsible to instantiate any service class.
public	SignalingGate This class represents a door of the `WebChannel` for the current peer.
public	Util Utility class contains some helper static methods.
public	WebChannel This class is an API starting point.
public	WebRTCService Service class responsible to establish connections between peers via `RTCDataChannel`.
public	WebSocketService Service class responsible to establish connections between peers via `WebSocket`.

Interface Summary

Static Public Interface Summary
public	TopologyInterface It is responsible to preserve Web Channel structure intact (i.e.

Function Summary

Static Public Function Summary
public	create(options: WebChannelSettings): WebChannel Create `WebChannel`.

Variable Summary

Static Public Variable Summary
public	WEB_RTC: number WebRTCService identifier.
public	WEB_SOCKET: number WebSocketService identifier.

Typedef Summary

Static Public Typedef Summary
public	MessageHeader: Object Header of the metadata of the messages sent/received over the `WebChannel`.
public	OpenData: Object Necessary data to join the `WebChannel`.
public	UserMessage: string \| ArrayBuffer \| TypedArray
public	WebChannelSettings: Object WebChannel settings

External Summary

Static Public External Summary
public	Promise.reject
public	Promise.resolve
public	RTCDataChannel
public	RTCIceCandidate
public	RTCIceServer
public	RTCPeerConnection
public	RTCSessionDescription
public	TypedArray
public	WebSocket
public	WebSocketServer