grpc

Documentation

Overview

Package grpc provides grpc utilities.

Index

• Variables
• func Dial(ctx context.Context, address string, logger logging.Logger, ...) (rpc.ClientConn, error)
• func InferSignalingServerAddress(address string) (string, bool, bool)
• type ForeignResource
  • func NewForeignResource(name resource.Name, conn rpc.ClientConn) *ForeignResource
  • func (res *ForeignResource) NewStub() grpcdynamic.Stub
  • func (res *ForeignResource) Reconfigure(ctx context.Context, deps resource.Dependencies, conf resource.Config) error
• type OnTrackCB
• type ReconfigurableClientConn
  • func (c *ReconfigurableClientConn) Close() error
  • func (c *ReconfigurableClientConn) Invoke(ctx context.Context, method string, args, reply interface{}, ...) error
  • func (c *ReconfigurableClientConn) NewStream(ctx context.Context, desc *googlegrpc.StreamDesc, method string, ...) (googlegrpc.ClientStream, error)
  • func (c *ReconfigurableClientConn) PeerConn() *webrtc.PeerConnection
  • func (c *ReconfigurableClientConn) ReplaceConn(conn rpc.ClientConn)
• type SharedConn
  • func NewSharedConn(conn *ReconfigurableClientConn, peerConn *webrtc.PeerConnection, ...) *SharedConn
  • func (sc *SharedConn) AddOnTrackSub(name resource.Name, onTrackCB OnTrackCB)
  • func (sc *SharedConn) Close() error
  • func (sc *SharedConn) PeerConn() *webrtc.PeerConnection
  • func (sc *SharedConn) RemoveOnTrackSub(name resource.Name)

Variables

var DefaultWebRTCConfiguration = webrtc.Configuration{
	ICEServers: []webrtc.ICEServer{
		{
			URLs: []string{"stun:global.stun.twilio.com:3478"},
		},
	},
}

DefaultWebRTCConfiguration is the default configuration to use.

var UnimplementedError = status.Error(codes.Unimplemented, codes.Unimplemented.String())

UnimplementedError is returned any time a gRPC method is unimplemented.

Functions

func Dial

func Dial(ctx context.Context, address string, logger logging.Logger, opts ...rpc.DialOption) (rpc.ClientConn, error)

Dial dials a gRPC server. `ctx` can be used to set a timeout/deadline for Dial. However, the signaling server may have other timeouts which may prevent the full timeout from being respected.

func InferSignalingServerAddress

func InferSignalingServerAddress(address string) (string, bool, bool)

InferSignalingServerAddress returns the appropriate WebRTC signaling server address if it can be detected. Returns the address, if the endpoint is secure, and if found. TODO(RSDK-235): remove hard coding of signaling server address and prefer SRV lookup instead.

Types

type ForeignResource

type ForeignResource struct {
	resource.Named
	resource.TriviallyCloseable
	// contains filtered or unexported fields
}

An ForeignResource is used to dynamically invoke RPC calls to resources that have their RPC information dervied on demand.

func NewForeignResource

func NewForeignResource(name resource.Name, conn rpc.ClientConn) *ForeignResource

NewForeignResource returns an ForeignResource for the given resource name and connection serving it.

func (*ForeignResource) NewStub

func (res *ForeignResource) NewStub() grpcdynamic.Stub

NewStub returns a new gRPC client stub used to communicate with the resource.

func (*ForeignResource) Reconfigure

func (res *ForeignResource) Reconfigure(ctx context.Context, deps resource.Dependencies, conf resource.Config) error

Reconfigure always fails.

type OnTrackCB

type OnTrackCB func(tr *webrtc.TrackRemote, r *webrtc.RTPReceiver)

OnTrackCB is the signature of the OnTrack callback function a resource may register with a SharedConn which supports WebRTC.

type ReconfigurableClientConn

type ReconfigurableClientConn struct {
	// contains filtered or unexported fields
}

ReconfigurableClientConn allows for the underlying client connections to be swapped under the hood.

func (*ReconfigurableClientConn) Close

func (c *ReconfigurableClientConn) Close() error

Close attempts to close the underlying client connection if there is one.

func (*ReconfigurableClientConn) Invoke

func (c *ReconfigurableClientConn) Invoke(
	ctx context.Context,
	method string,
	args, reply interface{},
	opts ...googlegrpc.CallOption,
) error

Invoke invokes using the underlying client connection. In the case of c.conn being closed in the middle of an Invoke call, it is expected that c.conn can handle that and return a well-formed error.

func (*ReconfigurableClientConn) NewStream

func (c *ReconfigurableClientConn) NewStream(
	ctx context.Context,
	desc *googlegrpc.StreamDesc,
	method string,
	opts ...googlegrpc.CallOption,
) (googlegrpc.ClientStream, error)

NewStream creates a new stream using the underlying client connection. In the case of c.conn being closed in the middle of a NewStream call, it is expected that c.conn can handle that and return a well-formed error.

func (*ReconfigurableClientConn) PeerConn

func (c *ReconfigurableClientConn) PeerConn() *webrtc.PeerConnection

PeerConn returns the backing PeerConnection object, if applicable. Nil otherwise.

func (*ReconfigurableClientConn) ReplaceConn

func (c *ReconfigurableClientConn) ReplaceConn(conn rpc.ClientConn)

ReplaceConn replaces the underlying client connection with the connection passed in. This does not close the old connection, the caller is expected to close it if needed.

type SharedConn

type SharedConn struct {
	*ReconfigurableClientConn
	// contains filtered or unexported fields
}

SharedConn wraps both a GRPC connection & (optionally) a peer connection & controls access to both. For modules, the grpc connection is over a Unix socket. The WebRTC `PeerConnection` is made separately. The `SharedConn` continues to implement the `rpc.ClientConn` interface by pairing up the two underlying connections a client may want to communicate over.

func NewSharedConn

func NewSharedConn(conn *ReconfigurableClientConn, peerConn *webrtc.PeerConnection, logger logging.Logger) *SharedConn

NewSharedConn returns a SharedConnection which manages access to both a grpc client conntection & (optionally) a webrtc peer connection.

func (*SharedConn) AddOnTrackSub

func (sc *SharedConn) AddOnTrackSub(name resource.Name, onTrackCB OnTrackCB)

AddOnTrackSub adds an OnTrack subscription for the resource.

func (*SharedConn) Close

func (sc *SharedConn) Close() error

Close closes a shared connection.

func (*SharedConn) PeerConn

func (sc *SharedConn) PeerConn() *webrtc.PeerConnection

PeerConn returns the PeerConnection.

func (*SharedConn) RemoveOnTrackSub

func (sc *SharedConn) RemoveOnTrackSub(name resource.Name)

RemoveOnTrackSub removes an OnTrack subscription for the resource.