echo-webrtc-client/io.github.alexandrepiveteau.echo.webrtc.client/Peer

Peer

interface Peer : PeerToPeerConnection
Content copied to clipboard

A Peer represents a remote peer, and the associated PeerToPeerConnection. Peers have a lifecycle, and may be cancelled when they're not reachable anymore.

Functions

Link copied to clipboard
abstract fun cancel()
Content copied to clipboard

Cancels the Peer, and stops all its synchronisation jobs.

Link copied to clipboard
abstract suspend fun receiveCatching(): ChannelResult<String>
Content copied to clipboard

Attempts to receive a message from the peer.

Link copied to clipboard
abstract suspend fun sendCatching(message: String): ChannelResult<Unit>
Content copied to clipboard

Attempts to send a message to the peer.

Properties

Link copied to clipboard
abstract val identifier: PeerIdentifier
Content copied to clipboard

The unique PeerIdentifier for this Peer.