stun

Aug 11, 2018

retracted

Changes in this version

type ClientOptions

+ Clock Clock

+ Collector Collector

+ RTO time.Duration

Aug 10, 2018

retracted

Changes in this version

type ClientOptions

+ Handler Handler

Aug 1, 2018

retracted

Changes in this version

+ var ErrAttrSizeInvalid = errors.New("attribute size is invalid")

Feb 16, 2018

retracted

Changes in this version

type Handler

+ HandleEvent func(e Event)

+ type HandlerFunc func(e Event)

+ func (f HandlerFunc) HandleEvent(e Event)

Oct 19, 2017

retracted

Changes in this version

+ type AgentEvent struct

+ Error error

+ Message *Message

+ type AgentFn func(e AgentEvent)

+ type AgentOptions struct

+ Handler AgentFn

+ type AttrLengthErr struct

+ Attr AttrType

+ Expected int

+ Got int

+ func (e AttrLengthErr) Error() string

+ type AttrOverflowErr struct

+ Got int

+ Max int

+ Type AttrType

+ func (e AttrOverflowErr) Error() string

+ type ClientOptions struct

+ Agent ClientAgent

+ Connection Connection

+ TimeoutRate time.Duration

Feb 26, 2017

retracted

Changes in this version

+ var ErrReasonLengthTooBig = errors.New("reason for ERROR-CODE is too big")

+ type AttrLengthError struct

+ Got int

+ Max int

+ Type AttrType

+ func (e AttrLengthError) Error() string

+ type CRCMismatch struct

+ Actual uint32

+ Expected uint32

+ func (m CRCMismatch) Error() string

+ type IntegrityErr struct

+ Actual []byte

+ Expected []byte

+ func (i *IntegrityErr) Error() string

May 19, 2023

Changes in this version

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

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

+ 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")

+ var ErrUnsupportedURI = fmt.Errorf("invalid schema or transport")

type Client

+ func DialURI(uri *URI, cfg *DialConfig) (*Client, error)

+ type DialConfig struct

+ DTLSConfig dtls.Config

+ Net transport.Net

+ TLSConfig tls.Config

+ type ProtoType int

+ const ProtoTypeTCP

+ const ProtoTypeUDP

+ const ProtoTypeUnknown

+ func NewProtoType(raw string) ProtoType

+ func (t ProtoType) String() string

+ type SchemeType int

+ const SchemeTypeSTUN

+ const SchemeTypeSTUNS

+ const SchemeTypeTURN

+ const SchemeTypeTURNS

+ const SchemeTypeUnknown

+ func NewSchemeType(raw string) SchemeType

+ func (t SchemeType) String() string

type URI

+ Password string

+ Proto ProtoType

+ Username string

+ func (u URI) IsSecure() bool

Jan 30, 2023

Changes in this version

type AttrType

+ const AttrAlternateDomain

+ const AttrCacheTimeout

+ const AttrMessageIntegritySHA256

+ const AttrPadding

+ const AttrPasswordAlgorithm

+ const AttrPasswordAlgorithms

+ const AttrResponseOrigin

+ const AttrResponsePort

+ const AttrUserhash

type MappedAddress

+ func (a *MappedAddress) AddToAs(m *Message, t AttrType) error

+ func (a *MappedAddress) GetFromAs(m *Message, t AttrType) error

type Message

+ func (m *Message) GobDecode(data []byte) error

+ func (m *Message) UnmarshalBinary(data []byte) error

+ func (m Message) GobEncode() ([]byte, error)

+ func (m Message) MarshalBinary() (data []byte, err error)

+ type ResponseOrigin struct

+ IP net.IP

+ Port int

+ func (o *ResponseOrigin) AddTo(m *Message) error

+ func (o *ResponseOrigin) GetFrom(m *Message) error

+ func (o ResponseOrigin) String() string

May 29, 2020

Changes in this version

type AttrType

+ const AttrChangeRequest

+ const AttrOtherAddress

+ type OtherAddress struct

+ IP net.IP

+ Port int

+ func (o *OtherAddress) AddTo(m *Message) error

+ func (o *OtherAddress) GetFrom(m *Message) error

+ func (o OtherAddress) String() string

May 21, 2019

Changes in this version

+ const CodeUnauthorised

+ const DefaultPort

+ const DefaultTLSPort

+ const Scheme

+ const SchemeSecure

+ var BindingError = NewType(MethodBinding, ClassErrorResponse)

+ var BindingRequest = NewType(MethodBinding, ClassRequest)

+ var BindingSuccess = NewType(MethodBinding, ClassSuccessResponse)

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

+ var ErrAttributeNotFound = errors.New("attribute not found")

+ var ErrAttributeSizeInvalid = errors.New("attribute size is invalid")

+ var ErrAttributeSizeOverflow = errors.New("attribute size overflow")

+ var ErrBadIPLength = errors.New("invalid length of IP value")

+ var ErrBadUnknownAttrsSize = errors.New("bad UNKNOWN-ATTRIBUTES size")

+ var ErrClientClosed = errors.New("client is closed")

+ var ErrClientNotInitialized = errors.New("client not initialized")

+ var ErrDecodeToNil = errors.New("attempt to decode to nil message")

+ var ErrFingerprintBeforeIntegrity = errors.New("FINGERPRINT before MESSAGE-INTEGRITY attribute")

+ var ErrFingerprintMismatch = errors.New("fingerprint check failed")

+ var ErrIntegrityMismatch = errors.New("integrity check failed")

+ var ErrNoConnection = errors.New("no connection provided")

+ var ErrNoDefaultReason = errors.New("no default reason for ErrorCode")

+ var ErrTransactionExists = errors.New("transaction exists with same id")

+ var ErrTransactionNotExists = errors.New("transaction not exists")

+ var ErrTransactionStopped = errors.New("transaction is stopped")

+ var ErrTransactionTimeOut = errors.New("transaction is timed out")

+ var ErrUnexpectedHeaderEOF = errors.New("unexpected EOF: not enough bytes to read header")

+ func CheckOverflow(_ AttrType, got, max int) error

+ func CheckSize(_ AttrType, got, expected int) error

+ func Decode(data []byte, m *Message) error

+ func FingerprintValue(b []byte) uint32

+ func IsAttrSizeInvalid(err error) bool

+ func IsAttrSizeOverflow(err error) bool

+ func IsMessage(b []byte) bool

+ func NewTransactionID() (b [TransactionIDSize]byte)

+ func WithNoRetransmit(c *Client)

+ type Agent struct

+ func NewAgent(h Handler) *Agent

+ func (a *Agent) Close() error

+ func (a *Agent) Collect(gcTime time.Time) error

+ func (a *Agent) Process(m *Message) error

+ func (a *Agent) SetHandler(h Handler) error

+ func (a *Agent) Start(id [TransactionIDSize]byte, deadline time.Time) error

+ func (a *Agent) Stop(id [TransactionIDSize]byte) error

+ func (a *Agent) StopWithError(id [TransactionIDSize]byte, err error) error

+ type AlternateServer struct

+ IP net.IP

+ Port int

+ func (s *AlternateServer) AddTo(m *Message) error

+ func (s *AlternateServer) GetFrom(m *Message) error

type AttrType

+ const AttrConnectionID

+ const AttrICEControlled

+ const AttrICEControlling

+ const AttrOrigin

+ const AttrRequestedAddressFamily

+ func (t AttrType) Optional() bool

+ func (t AttrType) Required() bool

+ func (t AttrType) Value() uint16

+ type Attributes []RawAttribute

+ func (a Attributes) Get(t AttrType) (RawAttribute, bool)

+ type Checker interface

+ Check func(m *Message) error

type Client

+ func Dial(network, address string) (*Client, error)

+ func (c *Client) Do(m *Message, f func(Event)) error

+ func (c *Client) Indicate(m *Message) error

+ func (c *Client) SetRTO(rto time.Duration)

+ func (c *Client) Start(m *Message, h Handler) error

+ type ClientAgent interface

+ Close func() error

+ Collect func(time.Time) error

+ Process func(*Message) error

+ SetHandler func(h Handler) error

+ Start func(id [TransactionIDSize]byte, deadline time.Time) error

+ Stop func(id [TransactionIDSize]byte) error

+ type ClientOption func(c *Client)

+ var WithNoConnClose ClientOption = func(c *Client) { ... }

+ func WithAgent(a ClientAgent) ClientOption

+ func WithClock(clock Clock) ClientOption

+ func WithCollector(coll Collector) ClientOption

+ func WithHandler(h Handler) ClientOption

+ func WithRTO(rto time.Duration) ClientOption

+ func WithTimeoutRate(d time.Duration) ClientOption

+ type Clock interface

+ Now func() time.Time

+ type CloseErr struct

+ AgentErr error

+ ConnectionErr error

+ func (c CloseErr) Error() string

+ type Collector interface

+ Close func() error

+ Start func(rate time.Duration, f func(now time.Time)) error

+ type Connection interface

+ type DecodeErr struct

+ Message string

+ Place DecodeErrPlace

+ func (e DecodeErr) Error() string

+ func (e DecodeErr) IsInvalidCookie() bool

+ func (e DecodeErr) IsPlace(p DecodeErrPlace) bool

+ func (e DecodeErr) IsPlaceChildren(c string) bool

+ func (e DecodeErr) IsPlaceParent(p string) bool

+ type DecodeErrPlace struct

+ Children string

+ Parent string

+ func (p DecodeErrPlace) String() string

type ErrorCode

+ const CodeAddrFamilyNotSupported

+ const CodeAllocMismatch

+ const CodeAllocQuotaReached

+ const CodeBadRequest

+ const CodeConnAlreadyExists

+ const CodeConnTimeoutOrFailure

+ const CodeForbidden

+ const CodeInsufficientCapacity

+ const CodePeerAddrFamilyMismatch

+ const CodeRoleConflict

+ const CodeServerError

+ const CodeStaleNonce

+ const CodeTryAlternate

+ const CodeUnauthorized

+ const CodeUnknownAttribute

+ const CodeUnsupportedTransProto

+ const CodeWrongCredentials

+ func (c ErrorCode) AddTo(m *Message) error

+ type ErrorCodeAttribute struct

+ Code ErrorCode

+ Reason []byte

+ func (c *ErrorCodeAttribute) GetFrom(m *Message) error

+ func (c ErrorCodeAttribute) AddTo(m *Message) error

+ func (c ErrorCodeAttribute) String() string

+ type Event struct

+ Error error

+ Message *Message

+ TransactionID [TransactionIDSize]byte

+ type FingerprintAttr struct

+ func (FingerprintAttr) AddTo(m *Message) error

+ func (FingerprintAttr) Check(m *Message) error

+ type Getter interface

+ GetFrom func(m *Message) error

+ type Handler func(e Event)

+ var NoopHandler Handler = func(e Event) { ... }

+ type MappedAddress struct

+ IP net.IP

+ Port int

+ func (a *MappedAddress) AddTo(m *Message) error

+ func (a *MappedAddress) GetFrom(m *Message) error

+ func (a MappedAddress) String() string

type Message

+ Type MessageType

+ func MustBuild(setters ...Setter) *Message

+ func New() *Message

+ func (m *Message) Add(t AttrType, v []byte)

+ func (m *Message) AddTo(b *Message) error

+ func (m *Message) Build(setters ...Setter) error

+ func (m *Message) Check(checkers ...Checker) error

+ func (m *Message) CloneTo(b *Message) error

+ func (m *Message) Contains(t AttrType) bool

+ func (m *Message) Decode() error

+ func (m *Message) Encode()

+ func (m *Message) Equal(b *Message) bool

+ func (m *Message) ForEach(t AttrType, f func(m *Message) error) error

+ func (m *Message) Get(t AttrType) ([]byte, error)

+ func (m *Message) NewTransactionID() error

+ func (m *Message) Parse(getters ...Getter) error

+ func (m *Message) ReadFrom(r io.Reader) (int64, error)

+ func (m *Message) Reset()

+ func (m *Message) SetType(t MessageType)

+ func (m *Message) String() string

+ func (m *Message) Write(tBuf []byte) (int, error)

+ func (m *Message) WriteAttributes()

+ func (m *Message) WriteHeader()

+ func (m *Message) WriteLength()

+ func (m *Message) WriteTo(w io.Writer) (int64, error)

+ func (m *Message) WriteTransactionID()

+ func (m *Message) WriteType()

type MessageIntegrity

+ func NewLongTermIntegrity(username, realm, password string) MessageIntegrity

+ func NewShortTermIntegrity(password string) MessageIntegrity

+ func (i MessageIntegrity) AddTo(m *Message) error

+ func (i MessageIntegrity) Check(m *Message) error

+ func (i MessageIntegrity) String() string

+ type MessageType struct

+ Class MessageClass

+ Method Method

+ func NewType(method Method, class MessageClass) MessageType

+ func (t *MessageType) ReadValue(v uint16)

+ func (t MessageType) AddTo(m *Message) error

+ func (t MessageType) String() string

+ func (t MessageType) Value() uint16

type Method

+ const MethodConnect

+ const MethodConnectionAttempt

+ const MethodConnectionBind

type Nonce

+ func NewNonce(nonce string) Nonce

+ func (n *Nonce) GetFrom(m *Message) error

+ func (n Nonce) AddTo(m *Message) error

+ func (n Nonce) String() string

type RawAttribute

+ func (a RawAttribute) AddTo(m *Message) error

+ func (a RawAttribute) Equal(b RawAttribute) bool

+ func (a RawAttribute) String() string

type Realm

+ func NewRealm(realm string) Realm

+ func (n *Realm) GetFrom(m *Message) error

+ func (n Realm) AddTo(m *Message) error

+ func (n Realm) String() string

+ type Setter interface

+ AddTo func(m *Message) error

+ var TransactionID Setter = transactionIDSetter{}

+ func NewTransactionIDSetter(value [TransactionIDSize]byte) Setter

type Software

+ func NewSoftware(software string) Software

+ func (s *Software) GetFrom(m *Message) error

+ func (s Software) AddTo(m *Message) error

+ func (s Software) String() string

+ type StopErr struct

+ Cause error

+ Err error

+ func (e StopErr) Error() string

+ type TextAttribute []byte

+ func (v *TextAttribute) GetFromAs(m *Message, t AttrType) error

+ func (v TextAttribute) AddToAs(m *Message, t AttrType, maxLen int) error

+ type URI struct

+ Host string

+ Port int

+ Scheme string

+ func ParseURI(rawURI string) (URI, error)

+ func (u URI) String() string

type UnknownAttributes

+ func (a *UnknownAttributes) GetFrom(m *Message) error

+ func (a UnknownAttributes) AddTo(m *Message) error

+ func (a UnknownAttributes) String() string

type Username

+ func NewUsername(username string) Username

+ func (u *Username) GetFrom(m *Message) error

+ func (u Username) AddTo(m *Message) error

+ func (u Username) String() string

+ type XORMappedAddress struct

+ IP net.IP

+ Port int

+ func (a *XORMappedAddress) GetFrom(m *Message) error

+ func (a *XORMappedAddress) GetFromAs(m *Message, t AttrType) error

+ func (a XORMappedAddress) AddTo(m *Message) error

+ func (a XORMappedAddress) AddToAs(m *Message, t AttrType) error

+ func (a XORMappedAddress) String() string

May 10, 2019

Changes in this version

type XorAddress

+ func GetMappedAddressUDP(conn *net.UDPConn, serverAddr net.Addr, deadline time.Duration) (*XorAddress, error)

Apr 4, 2019

Changes in this version

+ const ProtocolUDP

+ const TransactionIDSize

+ var Err300TryAlternate = ErrorCode

+ var Err400BadRequest = ErrorCode

+ var Err401Unauthorized = ErrorCode

+ var Err420UnknownAttributes = ErrorCode

+ var Err437AllocationMismatch = ErrorCode

+ var Err438StaleNonce = ErrorCode

+ var Err442UnsupportedTransportProtocol = ErrorCode

+ var Err500ServerError = ErrorCode

+ var Err508InsufficentCapacity = ErrorCode

+ var ErrResponseTooBig = errors.New("received too much data")

+ func BuildAndSend(conn net.PacketConn, addr *TransportAddr, class MessageClass, method Method, ...) error

+ func GenerateTransactionID() []byte

+ func IsSTUN(packet []byte) bool

+ func MessageIntegrityCalculateHMAC(key, message []byte) ([]byte, error)

+ type AttrType uint16

+ const AttrAlternateServer

+ const AttrBandwidth

+ const AttrChangeAddress

+ const AttrChangedAddress

+ const AttrChannelNumber

+ const AttrData

+ const AttrDontFragment

+ const AttrErrorCode

+ const AttrEvenPort

+ const AttrFingerprint

+ const AttrIceControlled

+ const AttrIceControlling

+ const AttrLifetime

+ const AttrMappedAddress

+ const AttrMessageIntegrity

+ const AttrNonce

+ const AttrPassword

+ const AttrPriority

+ const AttrRealm

+ const AttrReflectedFrom

+ const AttrRequestedTransport

+ const AttrReservationToken

+ const AttrResponseAddress

+ const AttrSoftware

+ const AttrSourceAddress

+ const AttrTimerVal

+ const AttrUnknownAttributes

+ const AttrUseCandidate

+ const AttrUsername

+ const AttrXORMappedAddress

+ const AttrXORPeerAddress

+ const AttrXORRelayedAddress

+ func (t AttrType) String() string

+ type Attribute interface

+ Pack func(message *Message) error

+ Unpack func(message *Message, rawAttribute *RawAttribute) error

+ type ChannelData struct

+ ChannelNumber uint16

+ Data []byte

+ Length uint16

+ func NewChannelData(packet []byte) (*ChannelData, error)

+ type ChannelNumber struct

+ ChannelNumber uint16

+ func (x *ChannelNumber) Pack(message *Message) error

+ func (x *ChannelNumber) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Client struct

+ func NewClient(protocol, server string, deadline time.Duration) (*Client, error)

+ func (c *Client) Close() error

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

+ func (c *Client) Request() (*Message, error)

+ type Data struct

+ Data []byte

+ func (d *Data) Pack(message *Message) error

+ func (d *Data) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type ErrorCode struct

+ ErrorClass int

+ ErrorNumber int

+ Reason []byte

+ func (e *ErrorCode) Pack(message *Message) error

+ func (e *ErrorCode) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type EvenPort struct

+ ReserveAdditional bool

+ func (e *EvenPort) Pack(message *Message) error

+ func (e *EvenPort) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Fingerprint struct

+ Fingerprint uint32

+ func (s *Fingerprint) Pack(message *Message) error

+ func (s *Fingerprint) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type IceControlled struct

+ TieBreaker uint64

+ func (i *IceControlled) Pack(message *Message) error

+ func (i *IceControlled) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type IceControlling struct

+ TieBreaker uint64

+ func (i *IceControlling) Pack(message *Message) error

+ func (i *IceControlling) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Lifetime struct

+ Duration uint32

+ func (x *Lifetime) Pack(message *Message) error

+ func (x *Lifetime) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Message struct

+ Attributes []*RawAttribute

+ Class MessageClass

+ Length uint16

+ Method Method

+ Raw []byte

+ TransactionID []byte

+ func Build(class MessageClass, method Method, transactionID []byte, attrs ...Attribute) (*Message, error)

+ func NewMessage(packet []byte) (*Message, error)

+ func (m *Message) AddAttribute(attrType AttrType, v []byte)

+ func (m *Message) CommitLength()

+ func (m *Message) GetAllAttributes(attrType AttrType) ([]*RawAttribute, bool)

+ func (m *Message) GetOneAttribute(attrType AttrType) (*RawAttribute, bool)

+ func (m *Message) Pack() []byte

+ type MessageClass byte

+ const ClassErrorResponse

+ const ClassIndication

+ const ClassRequest

+ const ClassSuccessResponse

+ func (m MessageClass) String() string

+ type MessageIntegrity struct

+ Key []byte

+ func (m *MessageIntegrity) Pack(message *Message) error

+ func (m *MessageIntegrity) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Method uint16

+ const MethodAllocate

+ const MethodBinding

+ const MethodChannelBind

+ const MethodCreatePermission

+ const MethodData

+ const MethodRefresh

+ const MethodSend

+ const MethodSharedSecret

+ func (m Method) String() string

+ type Nonce struct

+ Nonce string

+ func (n *Nonce) Pack(message *Message) error

+ func (n *Nonce) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type PacketType int

+ const PacketTypeChannelData

+ const PacketTypeSTUN

+ func GetPacketType(packet []byte) (PacketType, error)

+ type Priority struct

+ Priority uint32

+ func (p *Priority) Pack(message *Message) error

+ func (p *Priority) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type RawAttribute struct

+ Length uint16

+ Offset int

+ Pad uint16

+ Type AttrType

+ Value []byte

+ type Realm struct

+ Realm string

+ func (r *Realm) Pack(message *Message) error

+ func (r *Realm) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type RequestedTransport struct

+ Protocol protocolNumber

+ func (r *RequestedTransport) Pack(message *Message) error

+ func (r *RequestedTransport) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type ReservationToken struct

+ ReservationToken string

+ func (r *ReservationToken) Pack(message *Message) error

+ func (r *ReservationToken) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Software struct

+ Software string

+ func (s *Software) Pack(message *Message) error

+ func (s *Software) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type TransportAddr struct

+ IP net.IP

+ Port int

+ func NewTransportAddr(addr net.Addr) (*TransportAddr, error)

+ func (a *TransportAddr) Addr() net.Addr

+ func (a *TransportAddr) Equal(b *TransportAddr) bool

+ func (a *TransportAddr) String() string

+ type UnknownAttributes struct

+ Attributes []AttrType

+ func (u *UnknownAttributes) Pack(message *Message) error

+ func (u *UnknownAttributes) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type UseCandidate struct

+ func (u *UseCandidate) Pack(message *Message) error

+ func (u *UseCandidate) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type Username struct

+ Username string

+ func (u *Username) Pack(message *Message) error

+ func (u *Username) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type XorAddress struct

+ IP net.IP

+ Port int

+ func (x *XorAddress) Unpack(message *Message, rawAttribute *RawAttribute) error

+ type XorMappedAddress struct

+ func (x *XorMappedAddress) Pack(message *Message) error

+ type XorPeerAddress struct

+ func (x *XorPeerAddress) Pack(message *Message) error

+ type XorRelayedAddress struct

+ func (x *XorRelayedAddress) Pack(message *Message) error