PuterPeerConnection

The PuterPeerConnection object representing a WebRTC data-channel connection to a peer. puter.peer.connect() resolves to one, and a PuterPeerServer hands one to its connection event for every client that joins.

PuterPeerConnection extends EventTarget, so events are subscribed to with addEventListener().

Attributes

owner (Object)

Information about the user who created the server, with username and uuid.

room (String)

The room name this connection was made in, when the server was reached by name (see the name option of puter.peer.serve()). undefined for a connection made on an invite code.

connected (Boolean)

Whether the data channel is currently open.

closed (Boolean)

Whether the connection has been closed.

peerconnection (RTCPeerConnection)

The raw underlying RTCPeerConnection handle, for cases the Puter API does not cover.

Methods

send(data)

Sends a message to the peer. data may be a String, Blob, ArrayBuffer, or ArrayBufferView.

close(reason)

Closes the connection. The optional reason string is delivered to the peer on its close event.

Events

open

Fired when the data channel is ready. Wait for this before calling send().

message

Fired when a message is received. event.data holds the payload.

close

Fired when the connection closes. event.reason holds the reason, if one was given.

error

Fired when a connection error occurs. event.error holds the error. When the signaller refused the connection it is an Error whose code says why — no_host (a room nobody is serving right now), invalid_invite (an invite code that is not live) or invalid_auth — and close follows.

Example

const conn = await puter.peer.connect(inviteCode);

conn.addEventListener('open', () => {
    conn.send('Hello from the client!');
});
conn.addEventListener('message', (msg) => {
    puter.print('Server says:', msg.data);
});
conn.addEventListener('close', (event) => {
    puter.print('Connection closed:', event.reason);
});