ice

Feb 25, 2020

Changes in this version

type AgentConfig

+ InsecureSkipVerify bool

Dec 9, 2019

Changes in this version

+ var ErrInvalidMulticastDNSHostName = errors.New(...)

type AgentConfig

+ MulticastDNSHostName string

Dec 8, 2019

Changes in this version

+ var ErrLocalPwdInsufficientBits = errors.New("local password is less than 128 bits long")

+ var ErrLocalUfragInsufficientBits = errors.New("local username fragment is less than 24 bits long")

type AgentConfig

+ LocalPwd string

+ LocalUfrag string

Sep 25, 2019

Changes in this version

type AgentConfig

+ InterfaceFilter func(string) bool

Sep 24, 2019

Changes in this version

+ var ErrExternalMappedIPNotFound = errors.New("external mapped IP not found")

+ var ErrIneffectiveNAT1To1IPMappingHost = errors.New("1:1 NAT IP mapping for host candidate ineffective")

+ var ErrIneffectiveNAT1To1IPMappingSrflx = errors.New("1:1 NAT IP mapping for srflx candidate ineffective")

+ var ErrInvalidNAT1To1IPMapping = errors.New("invalid 1:1 NAT IP mapping")

+ var ErrMulticastDNSWithNAT1To1IPMapping = errors.New("mDNS gathering cannot be used with 1:1 NAT IP mapping for host candidate")

+ var ErrUnsupportedNAT1To1IPCandidateType = errors.New("unsupported 1:1 NAT IP candidate type")

type AgentConfig

+ NAT1To1IPCandidateType CandidateType

+ NAT1To1IPs []string

type CandidateType

+ const CandidateTypeUnspecified

Sep 7, 2019

Changes in this version

+ var ErrLiteUsingNonHostCandidates = errors.New("lite agents must only use host candidates")

+ var ErrUselessUrlsProvided = errors.New("agent does not need URL with selected candidate types")

type AgentConfig

+ Lite bool

Aug 22, 2019

Changes in this version

type Conn

+ func (c *Conn) BytesReceived() uint64

+ func (c *Conn) BytesSent() uint64

Jul 15, 2019

Changes in this version

type AgentConfig

+ Net *vnet.Net

type CandidateRelayConfig

+ OnClose func() error

Jun 25, 2019

Changes in this version

+ type CandidateHostConfig struct

+ Address string

+ CandidateID string

+ Component uint16

+ Network string

+ Port int

+ type CandidatePeerReflexiveConfig struct

+ Address string

+ CandidateID string

+ Component uint16

+ Network string

+ Port int

+ RelAddr string

+ RelPort int

+ type CandidateRelayConfig struct

+ Address string

+ CandidateID string

+ Component uint16

+ Network string

+ Port int

+ RelAddr string

+ RelPort int

+ type CandidateServerReflexiveConfig struct

+ Address string

+ CandidateID string

+ Component uint16

+ Network string

+ Port int

+ RelAddr string

+ RelPort int

Jun 22, 2019

Changes in this version

+ const CandidatePairStateFailed

+ const CandidatePairStateInProgress

+ const CandidatePairStateSucceeded

+ const CandidatePairStateWaiting

type Agent

+ func (a *Agent) GetCandidatePairsStats() []CandidatePairStats

+ func (a *Agent) GetLocalCandidatesStats() []CandidateStats

+ func (a *Agent) GetRemoteCandidatesStats() []CandidateStats

type Candidate

+ ID func() string

type CandidateHost

+ func (c *CandidateHost) ID() string

+ type CandidatePairState int

+ func (c CandidatePairState) String() string

+ type CandidatePairStats struct

+ AvailableIncomingBitrate float64

+ AvailableOutgoingBitrate float64

+ BytesReceived uint64

+ BytesSent uint64

+ CircuitBreakerTriggerCount uint32

+ ConsentExpiredTimestamp time.Time

+ ConsentRequestsSent uint64

+ CurrentRoundTripTime float64

+ FirstRequestTimestamp time.Time

+ LastPacketReceivedTimestamp time.Time

+ LastPacketSentTimestamp time.Time

+ LastRequestTimestamp time.Time

+ LastResponseTimestamp time.Time

+ LocalCandidateID string

+ Nominated bool

+ PacketsReceived uint32

+ PacketsSent uint32

+ RemoteCandidateID string

+ RequestsReceived uint64

+ RequestsSent uint64

+ ResponsesReceived uint64

+ ResponsesSent uint64

+ RetransmissionsReceived uint64

+ RetransmissionsSent uint64

+ State CandidatePairState

+ Timestamp time.Time

+ TotalRoundTripTime float64

type CandidatePeerReflexive

+ func (c *CandidatePeerReflexive) ID() string

type CandidateRelay

+ func (c *CandidateRelay) ID() string

type CandidateServerReflexive

+ func (c *CandidateServerReflexive) ID() string

+ type CandidateStats struct

+ CandidateType CandidateType

+ Deleted bool

+ ID string

+ IP string

+ NetworkType NetworkType

+ Port int

+ Priority uint32

+ RelayProtocol string

+ Timestamp time.Time

+ URL string

Jun 21, 2019

Changes in this version

+ var ErrAddressParseFailed = errors.New("failed to parse address")

type AgentConfig

+ MulticastDNSMode MulticastDNSMode

type Candidate

+ Address func() string

type CandidateHost

+ func (c *CandidateHost) Address() string

type CandidatePeerReflexive

+ func (c *CandidatePeerReflexive) Address() string

type CandidateRelay

+ func (c *CandidateRelay) Address() string

type CandidateServerReflexive

+ func (c *CandidateServerReflexive) Address() string

+ type MulticastDNSMode byte

+ const MulticastDNSModeDisabled

+ const MulticastDNSModeQueryAndGather

+ const MulticastDNSModeQueryOnly

Jun 3, 2019

Changes in this version

type AgentConfig

+ CandidateSelectionTimeout *time.Duration

+ HostAcceptanceMinWait *time.Duration

+ MaxBindingRequests *uint16

+ PrflxAcceptanceMinWait *time.Duration

+ RelayAcceptanceMinWait *time.Duration

+ SrflxAcceptanceMinWait *time.Duration

May 28, 2019

Changes in this version

+ var ErrMultipleGatherAttempted = errors.New("attempting to gather candidates during gathering state")

+ var ErrNoOnCandidateHandler = errors.New("no OnCandidate provided")

type Agent

+ func (a *Agent) GatherCandidates() error

+ func (a *Agent) OnCandidate(f func(Candidate)) error

type AgentConfig

+ Trickle bool

May 25, 2019

Changes in this version

+ var ErrPasswordEmpty = errors.New("password is empty")

+ var ErrUsernameEmpty = errors.New("username is empty")

type AgentConfig

+ CandidateTypes []CandidateType

type URL

+ Password string

+ Username string

May 24, 2019

Changes in this version

type Candidate

+ NetworkType func() NetworkType

+ type CandidateHost struct

+ func (c *CandidateHost) Component() uint16

+ func (c *CandidateHost) Equal(other Candidate) bool

+ func (c *CandidateHost) IP() net.IP

+ func (c *CandidateHost) LastReceived() time.Time

+ func (c *CandidateHost) LastSent() time.Time

+ func (c *CandidateHost) LocalPreference() uint16

+ func (c *CandidateHost) NetworkType() NetworkType

+ func (c *CandidateHost) Port() int

+ func (c *CandidateHost) Priority() uint32

+ func (c *CandidateHost) RelatedAddress() *CandidateRelatedAddress

+ func (c *CandidateHost) String() string

+ func (c *CandidateHost) Type() CandidateType

+ type CandidatePeerReflexive struct

+ func (c *CandidatePeerReflexive) Component() uint16

+ func (c *CandidatePeerReflexive) Equal(other Candidate) bool

+ func (c *CandidatePeerReflexive) IP() net.IP

+ func (c *CandidatePeerReflexive) LastReceived() time.Time

+ func (c *CandidatePeerReflexive) LastSent() time.Time

+ func (c *CandidatePeerReflexive) LocalPreference() uint16

+ func (c *CandidatePeerReflexive) NetworkType() NetworkType

+ func (c *CandidatePeerReflexive) Port() int

+ func (c *CandidatePeerReflexive) Priority() uint32

+ func (c *CandidatePeerReflexive) RelatedAddress() *CandidateRelatedAddress

+ func (c *CandidatePeerReflexive) String() string

+ func (c *CandidatePeerReflexive) Type() CandidateType

+ type CandidateRelay struct

+ func (c *CandidateRelay) Component() uint16

+ func (c *CandidateRelay) Equal(other Candidate) bool

+ func (c *CandidateRelay) IP() net.IP

+ func (c *CandidateRelay) LastReceived() time.Time

+ func (c *CandidateRelay) LastSent() time.Time

+ func (c *CandidateRelay) LocalPreference() uint16

+ func (c *CandidateRelay) NetworkType() NetworkType

+ func (c *CandidateRelay) Port() int

+ func (c *CandidateRelay) Priority() uint32

+ func (c *CandidateRelay) RelatedAddress() *CandidateRelatedAddress

+ func (c *CandidateRelay) String() string

+ func (c *CandidateRelay) Type() CandidateType

+ type CandidateServerReflexive struct

+ func (c *CandidateServerReflexive) Component() uint16

+ func (c *CandidateServerReflexive) Equal(other Candidate) bool

+ func (c *CandidateServerReflexive) IP() net.IP

+ func (c *CandidateServerReflexive) LastReceived() time.Time

+ func (c *CandidateServerReflexive) LastSent() time.Time

+ func (c *CandidateServerReflexive) LocalPreference() uint16

+ func (c *CandidateServerReflexive) NetworkType() NetworkType

+ func (c *CandidateServerReflexive) Port() int

+ func (c *CandidateServerReflexive) Priority() uint32

+ func (c *CandidateServerReflexive) RelatedAddress() *CandidateRelatedAddress

+ func (c *CandidateServerReflexive) String() string

+ func (c *CandidateServerReflexive) Type() CandidateType

May 21, 2019

Changes in this version

+ type AttrControl struct

+ Role Role

+ Tiebreaker uint64

+ func (c *AttrControl) GetFrom(m *stun.Message) error

+ func (c AttrControl) AddTo(m *stun.Message) error

+ type AttrControlled uint64

+ func (c *AttrControlled) GetFrom(m *stun.Message) error

+ func (c AttrControlled) AddTo(m *stun.Message) error

+ type AttrControlling uint64

+ func (c *AttrControlling) GetFrom(m *stun.Message) error

+ func (c AttrControlling) AddTo(m *stun.Message) error

+ type PriorityAttr uint32

+ func (p *PriorityAttr) GetFrom(m *stun.Message) error

+ func (p PriorityAttr) AddTo(m *stun.Message) error

+ type Role byte

+ const Controlled

+ const Controlling

+ func (r *Role) UnmarshalText(text []byte) error

+ func (r Role) MarshalText() (text []byte, err error)

+ func (r Role) String() string

+ type UseCandidateAttr struct

+ var UseCandidate UseCandidateAttr

+ func (UseCandidateAttr) AddTo(m *stun.Message) error

+ func (UseCandidateAttr) IsSet(m *stun.Message) bool

Apr 25, 2019

Changes in this version

+ var ErrCanceledByCaller = errors.New("connecting canceled by caller")

+ var ErrMultipleStart = errors.New("attempted to start agent twice")

+ var ErrRemotePwdEmpty = errors.New("remote pwd is empty")

+ var ErrRemoteUfragEmpty = errors.New("remote ufrag is empty")

Apr 4, 2019

Changes in this version

+ const ComponentRTCP

+ const ComponentRTP

+ const ConnectionStateChecking

+ const ConnectionStateClosed

+ const ConnectionStateCompleted

+ const ConnectionStateConnected

+ const ConnectionStateDisconnected

+ const ConnectionStateFailed

+ const ConnectionStateNew

+ const Unknown

+ var ErrClosed = errors.New("the agent is closed")

+ var ErrHost = errors.New("invalid hostname")

+ var ErrInvalidQuery = errors.New("invalid query")

+ var ErrNoCandidatePairs = errors.New("no candidate pairs available")

+ var ErrPort = errors.New("invalid port")

+ var ErrProtoType = errors.New("invalid transport protocol type")

+ var ErrSTUNQuery = errors.New("queries not supported in stun address")

+ var ErrSchemeType = errors.New("unknown scheme type")

+ var ErrUnknownType = errors.New("Unknown")

+ type Agent struct

+ func NewAgent(config *AgentConfig) (*Agent, error)

+ func (a *Agent) Accept(ctx context.Context, remoteUfrag, remotePwd string) (*Conn, error)

+ func (a *Agent) AddRemoteCandidate(c *Candidate) error

+ func (a *Agent) Close() error

+ func (a *Agent) Dial(ctx context.Context, remoteUfrag, remotePwd string) (*Conn, error)

+ func (a *Agent) GetLocalCandidates() ([]*Candidate, error)

+ func (a *Agent) GetLocalUserCredentials() (frag string, pwd string)

+ func (a *Agent) OnConnectionStateChange(f func(ConnectionState)) error

+ func (a *Agent) OnSelectedCandidatePairChange(f func(*Candidate, *Candidate)) error

+ type AgentConfig struct

+ ConnectionTimeout *time.Duration

+ KeepaliveInterval *time.Duration

+ LoggerFactory logging.LoggerFactory

+ NetworkTypes []NetworkType

+ PortMax uint16

+ PortMin uint16

+ Urls []*URL

+ type Candidate struct

+ Component uint16

+ IP net.IP

+ LocalPreference uint16

+ Port int

+ RelatedAddress *CandidateRelatedAddress

+ Type CandidateType

+ func NewCandidateHost(network string, ip net.IP, port int, component uint16) (*Candidate, error)

+ func NewCandidatePeerReflexive(network string, ip net.IP, port int, component uint16, relAddr string, ...) (*Candidate, error)

+ func NewCandidateRelay(network string, ip net.IP, port int, component uint16, relAddr string, ...) (*Candidate, error)

+ func NewCandidateServerReflexive(network string, ip net.IP, port int, component uint16, relAddr string, ...) (*Candidate, error)

+ func (c *Candidate) Equal(other *Candidate) bool

+ func (c *Candidate) LastReceived() time.Time

+ func (c *Candidate) LastSent() time.Time

+ func (c *Candidate) Priority() uint16

+ func (c *Candidate) String() string

+ type CandidateRelatedAddress struct

+ Address string

+ Port int

+ func (c *CandidateRelatedAddress) Equal(other *CandidateRelatedAddress) bool

+ func (c *CandidateRelatedAddress) String() string

+ type CandidateType byte

+ const CandidateTypeHost

+ const CandidateTypePeerReflexive

+ const CandidateTypeRelay

+ const CandidateTypeServerReflexive

+ func (c CandidateType) Preference() uint16

+ func (c CandidateType) String() string

+ type Conn struct

+ func (c *Conn) Close() error

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) Read(p []byte) (int, error)

+ func (c *Conn) RemoteAddr() net.Addr

+ func (c *Conn) SetDeadline(t time.Time) error

+ func (c *Conn) SetReadDeadline(t time.Time) error

+ func (c *Conn) SetWriteDeadline(t time.Time) error

+ func (c *Conn) Write(p []byte) (int, error)

+ type ConnectionState int

+ func (c ConnectionState) String() string

+ type GatheringState int

+ const GatheringStateComplete

+ const GatheringStateGathering

+ const GatheringStateNew

+ func (t GatheringState) String() string

+ type NetworkType int

+ const NetworkTypeTCP4

+ const NetworkTypeTCP6

+ const NetworkTypeUDP4

+ const NetworkTypeUDP6

+ func (t NetworkType) IsIPv4() bool

+ func (t NetworkType) IsIPv6() bool

+ func (t NetworkType) IsReliable() bool

+ func (t NetworkType) NetworkShort() string

+ func (t NetworkType) String() string

+ type ProtoType int

+ const ProtoTypeTCP

+ const ProtoTypeUDP

+ func NewProtoType(raw string) ProtoType

+ func (t ProtoType) String() string

+ type SchemeType int

+ const SchemeTypeSTUN

+ const SchemeTypeSTUNS

+ const SchemeTypeTURN

+ const SchemeTypeTURNS

+ func NewSchemeType(raw string) SchemeType

+ func (t SchemeType) String() string

+ type URL struct

+ Host string

+ Port int

+ Proto ProtoType

+ Scheme SchemeType

+ func ParseURL(raw string) (*URL, error)

+ func (u URL) IsSecure() bool

+ func (u URL) String() string