P2PCF
P2PCF enables free (or cheap) serverless WebRTC signalling using a Cloudflare worker and a Cloudflare R2 bucket. The API is inspired by P2PT, but instead of using WebTorrent trackers, which may go down, a custom Cloudflare worker is provided whose level of I/O aims to be free for most use-cases, and otherwise very cheap.
The point is to allow people to deploy WebRTC-enabled applications without having to manage or worry (much) about a signalling server. Out of the box the library will "just work" using a free public worker (run by the author) that is subject to quota. However, setting up your own worker is easy and takes just a few minutes. Once it is deployed, signalling will work without any further maintenance.
P2PCF also has some additional features:
- Room-based keying for easy connection management + acquisition
- Minimal initial signalling (1 or 2 signalling messages) using the technique put together by @evan_brass
- Subsequent signalling over DataChannels
- Efficient chunking + delivery of DataChannel messages that exceed the ~16k limit
- Peers handed back from the API are tiny-simple-peer instances which provides a simple API for interacting with the underlying PeerConnections (adding + removing media tracks, etc.)
Example + Usage
Out of the box, P2PCF will use a free public worker.
Once you're ready, you should set up your own worker on Cloudflare: https://github.com/gfodor/p2pcf/blob/master/INSTALL.md
A basic chat + video sharing example demonstrates the library at https://gfodor.github.io/p2pcf-demo (source)
Basic usage:
import P2PCF from 'p2pcf'
const client_id = 'MyUsername'
const room_id = 'MyRoom'
const p2pcf = new P2PCF(client_id, room_id, {
// Worker URL (optional) - if left out, will use a public worker
workerUrl: '<your worker url>',
// STUN ICE servers (optional)
// If left out, will use public STUN from Google + Twilio
stunIceServers: { ... },
// TURN ICE servers (optional)
// If left out, will use openrelay public TURN servers from metered.ca
turnIceServers: { ... },
// Network change poll interval (milliseconds, optional, default: 15000, 15 seconds)
// Interval to poll STUN for network changes + reconnect
networkChangePollIntervalMs: ...,
// State expiration interval (milliseconds, optional, default: 120000, 2 minutes)
// Timeout interval for peers during polling
stateExpirationIntervalMs: ...,
// State heartbeat interval (milliseconds, optional, default: 30000, 30 seconds)
// Time before expiration to heartbeat
stateHeartbeatWindowMs: ...,
// Fast polling rate (milliseconds, optional, default: 750)
// Polling rate during state transitions
fastPollingRateMs: ...,
// Slow polling rate (milliseconds, optional, default: 1500, 1.5 seconds)
// Polling rate when state is idle
slowPollingRateMs: ...,
// Options to pass to RTCPeerConnection constructor (optional)
rtcPeerConnectionOptions: {},
// Proprietary constraints to pass to RTCPeerConnection constructor (optional)
rtcPeerConnectionProprietaryConstraints: {},
// SDP transform function (optional)
sdpTransform: sdp => sdp
});
// Start polling
p2pcf.start()
p2pcf.on('peerconnect', peer => {
// New peer connected
// Peer is an instance of simple-peer (https://github.com/feross/simple-peer)
//
// The peer has two custom fields:
// - id (a per session unique id)
// - client_id (which was passed to their P2PCF constructor)
console.log("New peer:", peer.id, peer.client_id)
peer.on('track', (track, stream) => {
// New media track + stream from peer
})
// Add a media stream to the peer to start sending it
peer.addStream(new MediaStream(...))
})
p2pcf.on('peerclose', peer => {
// Peer has disconnected
})
p2pcf.on('msg', (peer, data) => {
// Received data from peer (data is an ArrayBuffer)
})
// Broadcast a message via data channel to all peers
p2pcf.broadcast(new ArrayBuffer(...))
// To send a message via data channel to just one peer:
p2pcf.send(peer, new ArrayBuffer(...))
// To stop polling + shut down (not necessary to call this typically, page transition suffices.)
p2pcf.destroy()
stunIceServers and turnIceServers are optional, but if provided, should be in the format of the iceServers option passed to RTCPeerConnection.
When a new peer joins, it can take up to slowPollingRateMs before negotiation will begin. If you want peers to connect more quickly, you can adjust slowPollingRateMs but it will result in increased worker requests and R2 reads.
Note that peers who are both on symmetric NATs (or one symmetric NAT + one port restricted NAT) will use TURN. If you do not specify a TURN server then the TURN server provided by Open Relay will be used. It's estimated 8% of visitors require TURN.
Estimated Cloudflare Usage
The worker provides signalling via HTTP polling (with backoff when the room is idle), and each request to the server performs a small number of reads from R2. Each join of a peer to the room will do at least 1 write to R2 and up to N + 1 writes (one for each peer, and a metadata update) in the worst-case where all peers are behind symmetric NATs and need to perform bi-directional hole punching to establish their initial DataChannel. Subsequent renegoations are performed over the DataChannel and so do not incur any R2 writes. Clients also heartbeat to maintain livliness every 90 seconds, which incurs an additional write each time.
R2's free tier offers 1M writes per month and 10M reads per month. Cloudflare workers offer ~3M free requests per month. In general, these free tiers should support any modest WebRTC application's signalling needs without the need to rely upon public signalling servers.
4 Nov 17, 2022
12 Jan 2, 2023
11 Nov 23, 2022
15.6k Jan 3, 2023
9 Jun 6, 2022
17 Dec 22, 2022
8 Nov 23, 2022
9 Nov 29, 2022
89 Jan 3, 2023
5 Aug 23, 2022
3 Mar 4, 2022
12 May 20, 2022
127 Jan 2, 2023
38 Dec 12, 2022
48 Dec 19, 2022
3 Jun 24, 2022
28 Dec 22, 2022
10 Sep 16, 2022
15 Nov 13, 2022