webrtc

Documentation

Overview

Package webrtc contains transports for WebRTC.

Index

• func NewSignalTransport(opts SignalOptions) transport.WebRTCSignalTransport
• type SignalOptions

Functions

func NewSignalTransport

func NewSignalTransport(opts SignalOptions) transport.WebRTCSignalTransport

NewSignalTransport returns a new WebRTC signaling transport that attempts to negotiate a WebRTC connection using the Webmesh WebRTC signaling server. This is typically used by clients trying to create a proxy connection to a server.

Types

type SignalOptions

type SignalOptions struct {
	// Resolver is a resolver for looking up nodes with the ICE negotiation feature.
	Resolver transport.FeatureResolver
	// Transport is the transport for creating gRPC connections.
	Transport transport.RPCTransport
	// NodeID is the id of the remote node to signal to.
	NodeID string
	// TargetProto is the target protocol to request from the remote node.
	TargetProto string
	// TargetAddr is the target address to request from the remote node.
	TargetAddr netip.AddrPort
}

SignalOptions are options for configuring the WebRTC transport.