Abstract peer to peer transport API for client and server.

Permit to create a fully connected peer to peer network based on WebRTC and WebSocket.

Allows to send/receive the following data types over the network: String, ArrayBuffer, TypedArray.

Table of contents

• Installation
• Usage
• Configuration
• Example

Full documentation: https://doc.esdoc.org/github.com/coast-team/netflux

API

create function is the start point, unless you are developing a peer bot, then consider using BotServer (see below). create functions return an object of type WebChannel which represents the peer to peer network.

dist/netflux.es2015.es.js and dist/netflux.es5.umd.minjs both exports:

• create(settings): WebChannel

  Members:

  • id: number
  • members: number[]
  • myId: number**
  • onMessage: function (peerId: number, msg: UserMessage, isBroadcast: boolean)**
  • onPeerJoin: function (peerId: number)
  • onPeerLeave: function (peerId: number)**
  • onClose: function (closeEvt: CloseEvent)**

  Methods:

  Open method allows other peers to join your network.
  

  • open([options: OpenData]): Promise<OpenData, string>
  • getOpenData(): OpenData | null
  • isOpen(): boolean
  • close()

  After someone has opened his network and has provided the key to you, you can join his network.
  

  • join(keyOrSocket: string | WebSocket[, url: string]): Promise<undefined, string>
  • leave()

  Any member can invite a peer bot (server) to join this network.
  

  • invite(urlOrSocket: string | WebSocket): Promise<undefined, string>

  Any member is allowed to send a message.
  

  • send(message: UserMessage)
  • sendTo(peerId: number, message: UserMessage)

  Or ping.
  

  • ping(): Promise<number, string>
• WEB_RTC constant
• WEB_SOCKET constant

• BotServer(settings)

  Members:

  • onWebChannel: function (wc: WebChannel)
  • webChannels: WebChannel[]

  Methods:

  • start(): Promise<undefined, string
  • stop()
  • addWebChannel(wc: WebChannel)
  • removeWebChannel(wc: WebChannel)
  • getWebChannel(id: number): WebChannel | null