routing

package
v0.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2021 License: Apache-2.0 Imports: 19 Imported by: 12

Documentation

Index

Constants

View Source 
const (
	// hash of node_id => Node proto
	NodesKey = "nodes"

	// hash of room_name => node_id
	NodeRoomKey = "room_node_map"
)

Variables

View Source 
var (
	ErrNotFound             = errors.New("could not find object")
	ErrIPNotSet             = errors.New("ip address is required and not set")
	ErrHandlerNotDefined    = errors.New("handler not defined")
	ErrIncorrectRTCNode     = errors.New("current node isn't the RTC node for the room")
	ErrNodeNotFound         = errors.New("could not locate the node")
	ErrInvalidRouterMessage = errors.New("invalid router message")
	ErrChannelClosed        = errors.New("channel closed")
	ErrChannelFull          = errors.New("channel is full")
)

Functions

func HashedID 

func HashedID(id string) string

Creates a hashed ID from a unique string

Types

type LocalNode 

type LocalNode *livekit.Node

func NewLocalNode 

func NewLocalNode(conf *config.Config) (LocalNode, error)

type LocalRouter 

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

a router of messages on the same node, basic implementation for local testing

func NewLocalRouter 

func NewLocalRouter(currentNode LocalNode) *LocalRouter

func (*LocalRouter) ClearRoomState 

func (r *LocalRouter) ClearRoomState(ctx context.Context, roomName string) error

func (*LocalRouter) Drain added in v0.13.5 

func (r *LocalRouter) Drain()

func (*LocalRouter) GetNode 

func (r *LocalRouter) GetNode(nodeId string) (*livekit.Node, error)

func (*LocalRouter) GetNodeForRoom 

func (r *LocalRouter) GetNodeForRoom(ctx context.Context, roomName string) (*livekit.Node, error)

func (*LocalRouter) ListNodes 

func (r *LocalRouter) ListNodes() ([]*livekit.Node, error)

func (*LocalRouter) OnNewParticipantRTC 

func (r *LocalRouter) OnNewParticipantRTC(callback NewParticipantCallback)

func (*LocalRouter) OnRTCMessage 

func (r *LocalRouter) OnRTCMessage(callback RTCMessageCallback)

func (*LocalRouter) RegisterNode 

func (r *LocalRouter) RegisterNode() error

func (*LocalRouter) RemoveDeadNodes 

func (r *LocalRouter) RemoveDeadNodes() error

func (*LocalRouter) SetNodeForRoom 

func (r *LocalRouter) SetNodeForRoom(ctx context.Context, roomName, nodeId string) error

func (*LocalRouter) Start 

func (r *LocalRouter) Start() error

func (*LocalRouter) StartParticipantSignal 

func (r *LocalRouter) StartParticipantSignal(ctx context.Context, roomName string, pi ParticipantInit) (connectionId string, reqSink MessageSink, resSource MessageSource, err error)

func (*LocalRouter) Stop 

func (r *LocalRouter) Stop()

func (*LocalRouter) UnregisterNode 

func (r *LocalRouter) UnregisterNode() error

func (*LocalRouter) WriteNodeRTC added in v0.14.2 

func (r *LocalRouter) WriteNodeRTC(ctx context.Context, nodeID string, msg *livekit.RTCNodeMessage) error

func (*LocalRouter) WriteParticipantRTC added in v0.14.2 

func (r *LocalRouter) WriteParticipantRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error

func (*LocalRouter) WriteRoomRTC added in v0.14.2 

func (r *LocalRouter) WriteRoomRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error

type MessageChannel 

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

func NewMessageChannel 

func NewMessageChannel() *MessageChannel

func (*MessageChannel) Close 

func (m *MessageChannel) Close()

func (*MessageChannel) IsClosed added in v0.13.1 

func (m *MessageChannel) IsClosed() bool

func (*MessageChannel) OnClose 

func (m *MessageChannel) OnClose(f func())

func (*MessageChannel) ReadChan 

func (m *MessageChannel) ReadChan() <-chan proto.Message

func (*MessageChannel) WriteMessage 

func (m *MessageChannel) WriteMessage(msg proto.Message) error

type MessageRouter added in v0.14.2 

type MessageRouter interface {
	// StartParticipantSignal participant signal connection is ready to start
	StartParticipantSignal(ctx context.Context, roomName string, pi ParticipantInit) (connectionId string, reqSink MessageSink, resSource MessageSource, err error)

	// Write a message to a participant, room, or node
	WriteParticipantRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error
	WriteRoomRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error
	WriteNodeRTC(ctx context.Context, nodeID string, msg *livekit.RTCNodeMessage) error

	// OnNewParticipantRTC is called to start a new participant's RTC connection
	OnNewParticipantRTC(callback NewParticipantCallback)

	// OnRTCMessage is called to execute actions on the RTC node
	OnRTCMessage(callback RTCMessageCallback)
}

type MessageSink 

type MessageSink interface {
	WriteMessage(msg proto.Message) error
	Close()
	OnClose(f func())
}

MessageSink is an abstraction for writing protobuf messages and having them read by a MessageSource, potentially on a different node via a transport

type MessageSource 

type MessageSource interface {
	// ReadChan exposes a one way channel to make it easier to use with select
	ReadChan() <-chan proto.Message
}

type NewParticipantCallback 

type NewParticipantCallback func(ctx context.Context, roomName string, pi ParticipantInit, requestSource MessageSource, responseSink MessageSink)

type ParticipantInit 

type ParticipantInit struct {
	Identity      string
	Metadata      string
	Reconnect     bool
	Permission    *livekit.ParticipantPermission
	AutoSubscribe bool
	Hidden        bool
	Client        *livekit.ClientInfo
}

type RTCMessageCallback 

type RTCMessageCallback func(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage)

type RTCNodeSink 

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

func NewRTCNodeSink 

func NewRTCNodeSink(rc *redis.Client, nodeId, participantKey string) *RTCNodeSink

func (*RTCNodeSink) Close 

func (s *RTCNodeSink) Close()

func (*RTCNodeSink) OnClose 

func (s *RTCNodeSink) OnClose(f func())

func (*RTCNodeSink) WriteMessage 

func (s *RTCNodeSink) WriteMessage(msg proto.Message) error

type RedisRouter 

type RedisRouter struct {
	LocalRouter
	// contains filtered or unexported fields
}

RedisRouter uses Redis pub/sub to route signaling messages across different nodes It relies on the RTC node to be the primary driver of the participant connection. Because

func NewRedisRouter 

func NewRedisRouter(currentNode LocalNode, rc *redis.Client) *RedisRouter

func (*RedisRouter) ClearRoomState 

func (r *RedisRouter) ClearRoomState(ctx context.Context, roomName string) error

func (*RedisRouter) Drain added in v0.13.5 

func (r *RedisRouter) Drain()

func (*RedisRouter) GetNode 

func (r *RedisRouter) GetNode(nodeId string) (*livekit.Node, error)

func (*RedisRouter) GetNodeForRoom 

func (r *RedisRouter) GetNodeForRoom(ctx context.Context, roomName string) (*livekit.Node, error)

func (*RedisRouter) ListNodes 

func (r *RedisRouter) ListNodes() ([]*livekit.Node, error)

func (*RedisRouter) RegisterNode 

func (r *RedisRouter) RegisterNode() error

func (*RedisRouter) RemoveDeadNodes 

func (r *RedisRouter) RemoveDeadNodes() error

func (*RedisRouter) SetNodeForRoom 

func (r *RedisRouter) SetNodeForRoom(ctx context.Context, roomName, nodeId string) error

func (*RedisRouter) Start 

func (r *RedisRouter) Start() error

func (*RedisRouter) StartParticipantSignal 

func (r *RedisRouter) StartParticipantSignal(ctx context.Context, roomName string, pi ParticipantInit) (connectionId string, reqSink MessageSink, resSource MessageSource, err error)

StartParticipantSignal signal connection sets up paths to the RTC node, and starts to route messages to that message queue

func (*RedisRouter) Stop 

func (r *RedisRouter) Stop()

func (*RedisRouter) UnregisterNode 

func (r *RedisRouter) UnregisterNode() error

func (*RedisRouter) WriteNodeRTC added in v0.14.2 

func (r *RedisRouter) WriteNodeRTC(ctx context.Context, rtcNodeID string, msg *livekit.RTCNodeMessage) error

func (*RedisRouter) WriteParticipantRTC added in v0.14.2 

func (r *RedisRouter) WriteParticipantRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error

func (*RedisRouter) WriteRoomRTC added in v0.14.2 

func (r *RedisRouter) WriteRoomRTC(ctx context.Context, roomName, identity string, msg *livekit.RTCNodeMessage) error

type Router 

type Router interface {
	MessageRouter

	RegisterNode() error
	UnregisterNode() error
	RemoveDeadNodes() error

	ListNodes() ([]*livekit.Node, error)

	GetNodeForRoom(ctx context.Context, roomName string) (*livekit.Node, error)
	SetNodeForRoom(ctx context.Context, roomName, nodeId string) error
	ClearRoomState(ctx context.Context, roomName string) error

	Start() error
	Drain()
	Stop()
}

Router allows multiple nodes to coordinate the participant session

func CreateRouter added in v0.13.5 

func CreateRouter(conf *config.Config, rc *redis.Client, node LocalNode) Router

type SignalNodeSink 

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

func NewSignalNodeSink 

func NewSignalNodeSink(rc *redis.Client, nodeId, connectionId string) *SignalNodeSink

func (*SignalNodeSink) Close 

func (s *SignalNodeSink) Close()

func (*SignalNodeSink) OnClose 

func (s *SignalNodeSink) OnClose(f func())

func (*SignalNodeSink) WriteMessage 

func (s *SignalNodeSink) WriteMessage(msg proto.Message) error

Source Files

View all Source files

Directories

Path Synopsis
Code generated by counterfeiter.
 Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.