sip

package
v1.33.0 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 19 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildSIPToken added in v1.9.4 

func BuildSIPToken(params SIPTokenParams) (string, error)

func DispatchRulePriority 

func DispatchRulePriority(info *livekit.SIPDispatchRuleInfo) int32

DispatchRulePriority returns sorting priority for dispatch rules. Lower value means higher priority.

func EvaluateDispatchRule 

func EvaluateDispatchRule(projectID string, trunk *livekit.SIPInboundTrunkInfo, rule *livekit.SIPDispatchRuleInfo, req *rpc.EvaluateSIPDispatchRulesRequest) (*rpc.EvaluateSIPDispatchRulesResponse, error)

EvaluateDispatchRule checks a selected Dispatch Rule against the provided request.

func GetPinAndRoom 

func GetPinAndRoom(info *livekit.SIPDispatchRuleInfo) (room, pin string, err error)

GetPinAndRoom returns a room name/prefix and the pin for a dispatch rule. Just a convenience wrapper.

func MatchDispatchRule deprecated 

func MatchDispatchRule(trunk *livekit.SIPInboundTrunkInfo, rules []*livekit.SIPDispatchRuleInfo, req *rpc.EvaluateSIPDispatchRulesRequest) (*livekit.SIPDispatchRuleInfo, error)

MatchDispatchRule finds the best dispatch rule matching the request parameters. Returns an error if no rule matched. Trunk parameter can be nil, in which case only wildcard dispatch rules will be effective (ones without Trunk IDs).

Deprecated: use MatchDispatchRuleIter

func MatchDispatchRuleIter added in v1.32.0 

func MatchDispatchRuleIter(trunk *livekit.SIPInboundTrunkInfo, rules iters.Iter[*livekit.SIPDispatchRuleInfo], req *rpc.EvaluateSIPDispatchRulesRequest) (*livekit.SIPDispatchRuleInfo, error)

MatchDispatchRuleIter finds the best dispatch rule matching the request parameters. Returns an error if no rule matched. Trunk parameter can be nil, in which case only wildcard dispatch rules will be effective (ones without Trunk IDs).

func MatchTrunk deprecated 

func MatchTrunk(trunks []*livekit.SIPInboundTrunkInfo, srcIP netip.Addr, calling, called string) (*livekit.SIPInboundTrunkInfo, error)

MatchTrunk finds a SIP Trunk definition matching the request. Returns nil if no rules matched or an error if there are conflicting definitions.

Deprecated: use MatchTrunkIter

func MatchTrunkIter added in v1.32.0 

func MatchTrunkIter(it iters.Iter[*livekit.SIPInboundTrunkInfo], srcIP netip.Addr, calling, called string) (*livekit.SIPInboundTrunkInfo, error)

MatchTrunkIter finds a SIP Trunk definition matching the request. Returns nil if no rules matched or an error if there are conflicting definitions.

func NewCallID added in v1.15.0 

func NewCallID() string

func SelectDispatchRule deprecated 

func SelectDispatchRule(rules []*livekit.SIPDispatchRuleInfo, req *rpc.EvaluateSIPDispatchRulesRequest) (*livekit.SIPDispatchRuleInfo, error)

SelectDispatchRule takes a list of dispatch rules, and takes the decision which one should be selected. It returns an error if there are conflicting rules. Returns nil if no rules match.

Deprecated: use MatchDispatchRuleIter

func SortDispatchRules 

func SortDispatchRules(rules []*livekit.SIPDispatchRuleInfo)

SortDispatchRules predictably sorts dispatch rules by priority (first one is highest).

func ValidateDispatchRules deprecated added in v1.10.1 

func ValidateDispatchRules(rules []*livekit.SIPDispatchRuleInfo) error

ValidateDispatchRules checks a set of dispatch rules for conflicts.

Deprecated: use ValidateDispatchRulesIter

func ValidateDispatchRulesIter added in v1.32.0 

func ValidateDispatchRulesIter(it iters.Iter[*livekit.SIPDispatchRuleInfo]) (best *livekit.SIPDispatchRuleInfo, _ error)

ValidateDispatchRulesIter checks a set of dispatch rules for conflicts.

func ValidateTrunks deprecated added in v1.10.1 

func ValidateTrunks(trunks []*livekit.SIPInboundTrunkInfo) error

ValidateTrunks checks a set of trunks for conflicts.

Deprecated: use ValidateTrunksIter

func ValidateTrunksIter added in v1.32.0 

func ValidateTrunksIter(it iters.Iter[*livekit.SIPInboundTrunkInfo]) error

ValidateTrunksIter checks a set of trunks for conflicts.

Types

type DispatchRuleValidator added in v1.32.0 

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

func NewDispatchRuleValidator added in v1.32.0 

func NewDispatchRuleValidator() *DispatchRuleValidator

func (*DispatchRuleValidator) Validate added in v1.32.0 

func (v *DispatchRuleValidator) Validate(r *livekit.SIPDispatchRuleInfo) error

func (*DispatchRuleValidator) ValidateIter added in v1.32.0 

func (v *DispatchRuleValidator) ValidateIter(it iters.Iter[*livekit.SIPDispatchRuleInfo]) iters.Iter[*livekit.SIPDispatchRuleInfo]

type ErrNoDispatchMatched added in v1.9.9 

type ErrNoDispatchMatched struct {
	NoRules      bool
	NoTrunks     bool
	CalledNumber string
}

func (*ErrNoDispatchMatched) Error added in v1.9.9 

func (e *ErrNoDispatchMatched) Error() string

type SIPTokenParams added in v1.31.0 

type SIPTokenParams struct {
	APIKey                string
	APISecret             string
	RoomName              string
	ParticipantIdentity   string
	ParticipantName       string
	ParticipantMetadata   string
	ParticipantAttributes map[string]string
	RoomPreset            string
	RoomConfig            *livekit.RoomConfiguration
}

Source Files

View all Source files

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.