mirror of
https://github.com/pion/ice.git
synced 2025-09-27 03:45:54 +08:00
47dad556f1
Added `AddExtension` and `RemoveExtension` methods to `ICECandidate`, allowing extensions to be managed dynamically. Ensure that `TCPType` is stored in one place (candidate.TCPType)
96 lines
2.8 KiB
Go
96 lines
2.8 KiB
Go
// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package ice
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
"time"
|
|
)
|
|
|
|
const (
|
|
receiveMTU = 8192
|
|
defaultLocalPreference = 65535
|
|
|
|
// ComponentRTP indicates that the candidate is used for RTP.
|
|
ComponentRTP uint16 = 1
|
|
// ComponentRTCP indicates that the candidate is used for RTCP.
|
|
ComponentRTCP
|
|
)
|
|
|
|
// Candidate represents an ICE candidate.
|
|
type Candidate interface {
|
|
// An arbitrary string used in the freezing algorithm to
|
|
// group similar candidates. It is the same for two candidates that
|
|
// have the same type, base IP address, protocol (UDP, TCP, etc.),
|
|
// and STUN or TURN server.
|
|
Foundation() string
|
|
|
|
// ID is a unique identifier for just this candidate
|
|
// Unlike the foundation this is different for each candidate
|
|
ID() string
|
|
|
|
// A component is a piece of a data stream.
|
|
// An example is one for RTP, and one for RTCP
|
|
Component() uint16
|
|
SetComponent(uint16)
|
|
|
|
// The last time this candidate received traffic
|
|
LastReceived() time.Time
|
|
|
|
// The last time this candidate sent traffic
|
|
LastSent() time.Time
|
|
|
|
NetworkType() NetworkType
|
|
Address() string
|
|
Port() int
|
|
|
|
Priority() uint32
|
|
|
|
// A transport address related to a
|
|
// candidate, which is useful for diagnostics and other purposes
|
|
RelatedAddress() *CandidateRelatedAddress
|
|
|
|
// Extensions returns a copy of all extension attributes associated with the ICECandidate.
|
|
// In the order of insertion, *(key value).
|
|
// Extension attributes are defined in RFC 5245, Section 15.1:
|
|
// https://datatracker.ietf.org/doc/html/rfc5245#section-15.1
|
|
//.
|
|
Extensions() []CandidateExtension
|
|
// GetExtension returns the value of the extension attribute associated with the ICECandidate.
|
|
// Extension attributes are defined in RFC 5245, Section 15.1:
|
|
// https://datatracker.ietf.org/doc/html/rfc5245#section-15.1
|
|
//.
|
|
GetExtension(key string) (value CandidateExtension, ok bool)
|
|
// AddExtension adds an extension attribute to the ICECandidate.
|
|
// If an extension with the same key already exists, it will be overwritten.
|
|
// Extension attributes are defined in RFC 5245, Section 15.1:
|
|
AddExtension(extension CandidateExtension) error
|
|
// RemoveExtension removes an extension attribute from the ICECandidate.
|
|
// Extension attributes are defined in RFC 5245, Section 15.1:
|
|
RemoveExtension(key string) (ok bool)
|
|
|
|
String() string
|
|
Type() CandidateType
|
|
TCPType() TCPType
|
|
|
|
Equal(other Candidate) bool
|
|
|
|
// DeepEqual same as Equal, But it also compares the candidate extensions.
|
|
DeepEqual(other Candidate) bool
|
|
|
|
Marshal() string
|
|
|
|
addr() net.Addr
|
|
filterForLocationTracking() bool
|
|
agent() *Agent
|
|
context() context.Context
|
|
|
|
close() error
|
|
copy() (Candidate, error)
|
|
seen(outbound bool)
|
|
start(a *Agent, conn net.PacketConn, initializedCh <-chan struct{})
|
|
writeTo(raw []byte, dst Candidate) (int, error)
|
|
}
|