package stun

Import Path
	github.com/pion/stun/v3 (on go.dev)

Dependency Relation
	imports 24 packages, and imported by 8 packages

Involved Source Files

	    addr.go
	    agent.go
	    attributes.go
	    checks.go
	    client.go
	    errorcode.go
	    errors.go
	    fingerprint.go
	    helpers.go
	    integrity.go
	    message.go
	  d stun.go
		Package stun implements Session Traversal Utilities for NAT (STUN) RFC 5389.
		
		The stun package is intended to use by package that implements extension
		to STUN (e.g. TURN) or client/server applications.
		
		Most methods are designed to be zero allocations. If it is not enough,
		low-level methods are available. On other hand, there are helpers that
		reduce code repeat.
		
		See examples for Message for basic usage, or https://github.com/pion/turn
		package for example of stun extension implementation.

	    textattrs.go
	    uattrs.go
	    uri.go
	    xoraddr.go
Package-Level Type Names (total 42)

	/* sort by: alphabet | popularity */
	 type Agent (struct)
		Agent is low-level abstraction over transaction list that
		handles concurrency (all calls are goroutine-safe) and
		time outs (via Collect call).

		Methods (total 7)
			(*Agent) Close() error
				Close terminates all transactions with ErrAgentClosed and renders Agent to
				closed state.

			(*Agent) Collect(gcTime time.Time) error
				Collect terminates all transactions that have deadline before provided
				time, blocking until all handlers will process ErrTransactionTimeOut.
				Will return ErrAgentClosed if agent is already closed.
				
				It is safe to call Collect concurrently but makes no sense.

			(*Agent) Process(m *Message) error
				Process incoming message, synchronously passing it to handler.

			(*Agent) SetHandler(h Handler) error
				SetHandler sets agent handler to h.

			(*Agent) Start(id [12]byte, deadline time.Time) error
				Start registers transaction with provided id and deadline.
				Could return ErrAgentClosed, ErrTransactionExists.
				
				Agent handler is guaranteed to be eventually called.

			(*Agent) Stop(id [12]byte) error
				Stop stops transaction by id with ErrTransactionStopped, blocking
				until handler returns.

			(*Agent) StopWithError(id [12]byte, err error) error
				StopWithError removes transaction from list and calls handler with
				provided error. Can return ErrTransactionNotExists and ErrAgentClosed.

		Implements (at least 3)
			*Agent : ClientAgent
			*Agent : github.com/prometheus/common/expfmt.Closer
			*Agent : io.Closer
		As Outputs Of (at least one exported)
			func NewAgent(h Handler) *Agent

	 type AlternateServer (struct)
		AlternateServer represents ALTERNATE-SERVER attribute.
		
		RFC 5389 Section 15.11

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 2)
			(*AlternateServer) AddTo(m *Message) error
				AddTo adds ALTERNATE-SERVER attribute to message.

			(*AlternateServer) GetFrom(m *Message) error
				GetFrom decodes ALTERNATE-SERVER from message.

		Implements (at least 2)
			*AlternateServer : Getter
			*AlternateServer : Setter

	 type Attributes ([])
		Attributes is list of message attributes.

		Methods (only one)
			( Attributes) Get(t AttrType) (RawAttribute, bool)
				Get returns first attribute from list by the type.
				If attribute is present the RawAttribute is returned and the
				boolean is true. Otherwise the returned RawAttribute will be
				empty and boolean will be false.


	 type AttrType uint16 (basic type)
		AttrType is attribute type.

		Methods (total 4)
			( AttrType) Optional() bool
				Optional returns true if type is from comprehension-optional range (0x8000-0xFFFF).

			( AttrType) Required() bool
				Required returns true if type is from comprehension-required range (0x0000-0x7FFF).

			( AttrType) String() string
			( AttrType) Value() uint16
				Value returns uint16 representation of attribute type.

		Implements (at least 2)
			 AttrType : expvar.Var
			 AttrType : fmt.Stringer
		As Inputs Of (at least 13)
			func CheckOverflow(_ AttrType, got, max int) error
			func CheckSize(_ AttrType, got, expected int) error
			func Attributes.Get(t AttrType) (RawAttribute, bool)
			func (*MappedAddress).AddToAs(m *Message, t AttrType) error
			func (*MappedAddress).GetFromAs(m *Message, t AttrType) error
			func (*Message).Add(t AttrType, v []byte)
			func (*Message).Contains(t AttrType) bool
			func (*Message).ForEach(t AttrType, f func(m *Message) error) error
			func (*Message).Get(t AttrType) ([]byte, error)
			func TextAttribute.AddToAs(m *Message, t AttrType, maxLen int) error
			func (*TextAttribute).GetFromAs(m *Message, t AttrType) error
			func XORMappedAddress.AddToAs(m *Message, t AttrType) error
			func (*XORMappedAddress).GetFromAs(m *Message, t AttrType) error
		As Types Of (total 40)
			const AttrAlternateDomain
			const AttrAlternateServer
			const AttrCacheTimeout
			const AttrChangedAddress
			const AttrChangeRequest
			const AttrChannelNumber
			const AttrConnectionID
			const AttrData
			const AttrDontFragment
			const AttrErrorCode
			const AttrEvenPort
			const AttrFingerprint
			const AttrICEControlled
			const AttrICEControlling
			const AttrLifetime
			const AttrMappedAddress
			const AttrMessageIntegrity
			const AttrMessageIntegritySHA256
			const AttrNonce
			const AttrOrigin
			const AttrOtherAddress
			const AttrPadding
			const AttrPasswordAlgorithm
			const AttrPasswordAlgorithms
			const AttrPriority
			const AttrRealm
			const AttrRequestedAddressFamily
			const AttrRequestedTransport
			const AttrReservationToken
			const AttrResponseOrigin
			const AttrResponsePort
			const AttrSoftware
			const AttrSourceAddress
			const AttrUnknownAttributes
			const AttrUseCandidate
			const AttrUserhash
			const AttrUsername
			const AttrXORMappedAddress
			const AttrXORPeerAddress
			const AttrXORRelayedAddress

	 type Checker (interface)
		Checker checks *Message attribute.

		Methods (only one)
			( Checker) Check(m *Message) error
		Implemented By (at least 2)
			 FingerprintAttr
			 MessageIntegrity
		As Inputs Of (at least one exported)
			func (*Message).Check(checkers ...Checker) error

	 type Client (struct)
		Client simulates "connection" to STUN server.

		Methods (total 5)
			(*Client) Close() error
				Close stops internal connection and agent, returning CloseErr on error.

			(*Client) Do(m *Message, f func(Event)) error
				Do is Start wrapper that waits until callback is called. If no callback
				provided, Indicate is called instead.
				
				Do has cpu overhead due to blocking, see BenchmarkClient_Do.
				Use Start method for less overhead.

			(*Client) Indicate(m *Message) error
				Indicate sends indication m to server. Shorthand to Start call
				with zero deadline and callback.

			(*Client) SetRTO(rto time.Duration)
				SetRTO sets current RTO value.

			(*Client) Start(m *Message, h Handler) error
				Start starts transaction (if h set) and writes message to server, handler
				is called asynchronously.

		Implements (at least 2)
			*Client : github.com/prometheus/common/expfmt.Closer
			*Client : io.Closer
		As Outputs Of (at least 3)
			func Dial(network, address string) (*Client, error)
			func DialURI(uri *URI, cfg *DialConfig) (*Client, error)
			func NewClient(conn Connection, options ...ClientOption) (*Client, error)
		As Inputs Of (at least one exported)
			func WithNoRetransmit(c *Client)

	 type ClientAgent (interface)
		ClientAgent is Agent implementation that is used by Client to
		process transactions.

		Methods (total 6)
			( ClientAgent) Close() error
			( ClientAgent) Collect(time.Time) error
			( ClientAgent) Process(*Message) error
			( ClientAgent) SetHandler(h Handler) error
			( ClientAgent) Start(id [12]byte, deadline time.Time) error
			( ClientAgent) Stop(id [12]byte) error
		Implemented By (at least one exported)
			*Agent
		Implements (at least 2)
			 ClientAgent : github.com/prometheus/common/expfmt.Closer
			 ClientAgent : io.Closer
		As Inputs Of (at least one exported)
			func WithAgent(a ClientAgent) ClientOption

	 type ClientOption (func)
		ClientOption sets some client option.

		As Outputs Of (at least 7)
			func WithAgent(a ClientAgent) ClientOption
			func WithClock(clock Clock) ClientOption
			func WithCollector(coll Collector) ClientOption
			func WithHandler(h Handler) ClientOption
			func WithNoConnClose() ClientOption
			func WithRTO(rto time.Duration) ClientOption
			func WithTimeoutRate(d time.Duration) ClientOption
		As Inputs Of (at least one exported)
			func NewClient(conn Connection, options ...ClientOption) (*Client, error)

	 type Clock (interface)
		Clock abstracts the source of current time.

		Methods (only one)
			( Clock) Now() time.Time
		Implemented By (at least 16)
			 github.com/pion/stun.Clock (interface)
			 github.com/benbjohnson/clock.Clock (interface)
			*github.com/benbjohnson/clock.Mock
			 github.com/hibiken/asynq/internal/timeutil.Clock (interface)
			*github.com/hibiken/asynq/internal/timeutil.SimulatedClock
			 github.com/libp2p/go-libp2p/p2p/host/autorelay.ClockWithInstantTimer (interface)
			 github.com/libp2p/go-libp2p/p2p/host/autorelay.RealClock
			 github.com/libp2p/go-libp2p/p2p/net/swarm.Clock (interface)
			 github.com/libp2p/go-libp2p/p2p/net/swarm.RealClock
			 github.com/quic-go/quic-go/internal/congestion.Clock (interface)
			 github.com/quic-go/quic-go/internal/congestion.DefaultClock
			 go.uber.org/dig/internal/digclock.Clock (interface)
			*go.uber.org/dig/internal/digclock.Mock
			 go.uber.org/fx/internal/fxclock.Clock (interface)
			*go.uber.org/fx/internal/fxclock.Mock
			 go.uber.org/zap/zapcore.Clock (interface)
		Implements (at least 3)
			 Clock : github.com/pion/stun.Clock
			 Clock : github.com/hibiken/asynq/internal/timeutil.Clock
			 Clock : github.com/quic-go/quic-go/internal/congestion.Clock
		As Inputs Of (at least one exported)
			func WithClock(clock Clock) ClientOption

	 type CloseErr (struct)
		CloseErr indicates client close failure.

		Fields (total 2)
			AgentErr error
			ConnectionErr error
		Methods (only one)
			( CloseErr) Error() string
		Implements (at least one exported)
			 CloseErr : error

	 type Collector (interface)
		Collector calls function f with constant rate.
		
		The simple Collector is ticker which calls function on each tick.

		Methods (total 2)
			( Collector) Close() error
			( Collector) Start(rate time.Duration, f func(now time.Time)) error
		Implemented By (at least one exported)
			 github.com/pion/stun.Collector (interface)
		Implements (at least 3)
			 Collector : github.com/pion/stun.Collector
			 Collector : github.com/prometheus/common/expfmt.Closer
			 Collector : io.Closer
		As Inputs Of (at least one exported)
			func WithCollector(coll Collector) ClientOption

	 type Connection (interface)
		Connection wraps Reader, Writer and Closer interfaces.

		Methods (total 3)
			( Connection) Close() error
			( Connection) Read(p []byte) (n int, err error)
			( Connection) Write([]byte) (int, error)
		Implemented By (at least 67)
			 github.com/pion/stun.Connection (interface)
			*github.com/pion/datachannel.DataChannel
			 github.com/pion/datachannel.ReadWriteCloser (interface)
			 github.com/pion/datachannel.ReadWriteCloserDeadliner (interface)
			*github.com/pion/dtls/v2.Conn
			*github.com/pion/dtls/v3.Conn
			*github.com/pion/ice/v4.Conn
			 github.com/pion/ice/v4/internal/fakenet.PacketConn
			*github.com/pion/sctp.Stream
			 github.com/pion/transport/v2.TCPConn (interface)
			 github.com/pion/transport/v2.UDPConn (interface)
			*github.com/pion/transport/v2/packetio.Buffer
			*github.com/pion/transport/v2/udp.Conn
			 github.com/pion/transport/v3.TCPConn (interface)
			 github.com/pion/transport/v3.UDPConn (interface)
			*github.com/pion/transport/v3/packetio.Buffer
			*github.com/pion/transport/v3/vnet.UDPConn
			 github.com/pion/turn/v4/internal/client.TCPConn
			*github.com/pion/webrtc/v4/internal/mux.Endpoint
			 github.com/apache/thrift/lib/go/thrift.RichTransport
			*github.com/apache/thrift/lib/go/thrift.StreamTransport
			*github.com/apache/thrift/lib/go/thrift.TBufferedTransport
			*github.com/apache/thrift/lib/go/thrift.TFramedTransport
			*github.com/apache/thrift/lib/go/thrift.THeaderTransport
			*github.com/apache/thrift/lib/go/thrift.THttpClient
			*github.com/apache/thrift/lib/go/thrift.TMemoryBuffer
			*github.com/apache/thrift/lib/go/thrift.TSocket
			*github.com/apache/thrift/lib/go/thrift.TSSLSocket
			 github.com/apache/thrift/lib/go/thrift.TTransport (interface)
			*github.com/apache/thrift/lib/go/thrift.TZlibTransport
			 github.com/coreos/etcd/pkg/fileutil.LockedFile
			 github.com/gdamore/tcell/v2.Tty (interface)
			 github.com/gliderlabs/ssh.Session (interface)
			 github.com/libp2p/go-libp2p/core/network.MuxedStream (interface)
			 github.com/libp2p/go-libp2p/core/network.Stream (interface)
			 github.com/libp2p/go-libp2p/core/sec.SecureConn (interface)
			 github.com/libp2p/go-libp2p/core/sec/insecure.Conn
			*github.com/libp2p/go-libp2p/p2p/net/swarm.Stream
			*github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/client.Conn
			 github.com/libp2p/go-libp2p/p2p/transport/tcpreuse/internal/sampledconn.ManetTCPConnInterface (interface)
			*github.com/libp2p/go-libp2p/p2p/transport/websocket.Conn
			 github.com/libp2p/go-msgio.ReadWriteCloser (interface)
			*github.com/libp2p/go-yamux/v5.Stream
			 github.com/marten-seemann/tcp.Conn
			*github.com/miekg/dns.Conn
			 github.com/miekg/dns.Transfer
			 github.com/multiformats/go-multiaddr/net.Conn (interface)
			 github.com/multiformats/go-multistream.LazyConn (interface)
			*github.com/ncruces/go-sqlite3.Blob
			*github.com/polarsignals/wal/fs.File
			 github.com/quic-go/quic-go.Stream (interface)
			 github.com/quic-go/quic-go/http3.RequestStream (interface)
			 github.com/quic-go/quic-go/http3.Stream (interface)
			 github.com/quic-go/webtransport-go.Stream (interface)
			*github.com/soheilhy/cmux.MuxConn
			*crypto/tls.Conn
			 golang.org/x/crypto/ssh.Channel (interface)
			 golang.org/x/net/internal/socks.Conn
			*golang.org/x/net/ipv4.RawConn
			*internal/poll.FD
			 io.ReadWriteCloser (interface)
			 net.Conn (interface)
			*net.IPConn
			*net.TCPConn
			*net.UDPConn
			*net.UnixConn
			*os.File
		Implements (at least 11)
			 Connection : github.com/pion/stun.Connection
			 Connection : github.com/miekg/dns.Writer
			 Connection : github.com/prometheus/common/expfmt.Closer
			 Connection : internal/bisect.Writer
			 Connection : io.Closer
			 Connection : io.ReadCloser
			 Connection : io.Reader
			 Connection : io.ReadWriteCloser
			 Connection : io.ReadWriter
			 Connection : io.WriteCloser
			 Connection : io.Writer
		As Inputs Of (at least one exported)
			func NewClient(conn Connection, options ...ClientOption) (*Client, error)

	 type DecodeErr (struct)
		DecodeErr records an error and place when it is occurred.

		Fields (total 2)
			Message string
			Place DecodeErrPlace
		Methods (total 5)
			( DecodeErr) Error() string
			( DecodeErr) IsInvalidCookie() bool
				IsInvalidCookie returns true if error means that magic cookie
				value is invalid.

			( DecodeErr) IsPlace(p DecodeErrPlace) bool
				IsPlace reports if error place is p.

			( DecodeErr) IsPlaceChildren(c string) bool
				IsPlaceChildren reports if error place children is c.

			( DecodeErr) IsPlaceParent(p string) bool
				IsPlaceParent reports if error place parent is p.

		Implements (at least one exported)
			 DecodeErr : error

	 type DecodeErrPlace (struct)
		DecodeErrPlace records a place where error is occurred.

		Fields (total 2)
			Children string
			Parent string
		Methods (only one)
			( DecodeErrPlace) String() string
		Implements (at least 2)
			 DecodeErrPlace : expvar.Var
			 DecodeErrPlace : fmt.Stringer
		As Inputs Of (at least one exported)
			func DecodeErr.IsPlace(p DecodeErrPlace) bool

	 type DialConfig (struct)
		DialConfig is used to pass configuration to DialURI()

		Fields (total 3)
			DTLSConfig dtls.Config
			Net transport.Net
			TLSConfig tls.Config
		As Inputs Of (at least one exported)
			func DialURI(uri *URI, cfg *DialConfig) (*Client, error)

	 type ErrorCode int (basic type)
		ErrorCode is code for ERROR-CODE attribute.

		Methods (only one)
			( ErrorCode) AddTo(m *Message) error
				AddTo adds ERROR-CODE with default reason to m. If there
				is no default reason, returns ErrNoDefaultReason.

		Implements (at least one exported)
			 ErrorCode : Setter
		As Types Of (total 18)
			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 CodeUnauthorised
			const CodeUnauthorized
			const CodeUnknownAttribute
			const CodeUnsupportedTransProto
			const CodeWrongCredentials

	 type ErrorCodeAttribute (struct)
		ErrorCodeAttribute represents ERROR-CODE attribute.
		
		RFC 5389 Section 15.6

		Fields (total 2)
			Code ErrorCode
			Reason []byte
		Methods (total 3)
			( ErrorCodeAttribute) AddTo(m *Message) error
				AddTo adds ERROR-CODE to m.

			(*ErrorCodeAttribute) GetFrom(m *Message) error
				GetFrom decodes ERROR-CODE from m. Reason is valid until m.Raw is valid.

			( ErrorCodeAttribute) String() string
		Implements (at least 4)
			*ErrorCodeAttribute : Getter
			 ErrorCodeAttribute : Setter
			 ErrorCodeAttribute : expvar.Var
			 ErrorCodeAttribute : fmt.Stringer

	 type Event (struct)
		Event is passed to Handler describing the transaction event.
		Do not reuse outside Handler.

		Fields (total 3)
			Error error
			Message *Message
			TransactionID [12]byte

	 type FingerprintAttr (struct)
		FingerprintAttr represents FINGERPRINT attribute.
		
		RFC 5389 Section 15.5

		Methods (total 2)
			( FingerprintAttr) AddTo(m *Message) error
				AddTo adds fingerprint to message.

			( FingerprintAttr) Check(m *Message) error
				Check reads fingerprint value from m and checks it, returning error if any.
				Can return *AttrLengthErr, ErrAttributeNotFound, and *CRCMismatch.

		Implements (at least 2)
			 FingerprintAttr : Checker
			 FingerprintAttr : Setter
		As Types Of (only one)
			  var Fingerprint

	 type Getter (interface)
		Getter parses attribute from *Message.

		Methods (only one)
			( Getter) GetFrom(m *Message) error
		Implemented By (at least 26)
			*AlternateServer
			*ErrorCodeAttribute
			*MappedAddress
			*Nonce
			*OtherAddress
			*Realm
			*ResponseOrigin
			*Software
			*UnknownAttributes
			*Username
			*XORMappedAddress
			*github.com/pion/ice/v4.AttrControl
			*github.com/pion/ice/v4.AttrControlled
			*github.com/pion/ice/v4.AttrControlling
			*github.com/pion/ice/v4.PriorityAttr
			*github.com/pion/turn/v4/internal/proto.ChannelNumber
			*github.com/pion/turn/v4/internal/proto.ConnectionID
			*github.com/pion/turn/v4/internal/proto.Data
			*github.com/pion/turn/v4/internal/proto.DontFragment
			*github.com/pion/turn/v4/internal/proto.EvenPort
			*github.com/pion/turn/v4/internal/proto.Lifetime
			*github.com/pion/turn/v4/internal/proto.PeerAddress
			*github.com/pion/turn/v4/internal/proto.RelayedAddress
			*github.com/pion/turn/v4/internal/proto.RequestedAddressFamily
			*github.com/pion/turn/v4/internal/proto.RequestedTransport
			*github.com/pion/turn/v4/internal/proto.ReservationToken
		As Inputs Of (at least one exported)
			func (*Message).Parse(getters ...Getter) error

	 type Handler (func)
		Handler handles state changes of transaction.
		
		Handler is called on transaction state change.
		Usage of e is valid only during call, user must
		copy needed fields explicitly.

		As Outputs Of (at least one exported)
			func NoopHandler() Handler
		As Inputs Of (at least 5)
			func NewAgent(h Handler) *Agent
			func WithHandler(h Handler) ClientOption
			func (*Agent).SetHandler(h Handler) error
			func (*Client).Start(m *Message, h Handler) error
			func ClientAgent.SetHandler(h Handler) error

	 type MappedAddress (struct)
		MappedAddress represents MAPPED-ADDRESS attribute.
		
		This attribute is used only by servers for achieving backwards
		compatibility with RFC 3489 clients.
		
		RFC 5389 Section 15.1

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 5)
			(*MappedAddress) AddTo(m *Message) error
				AddTo adds MAPPED-ADDRESS to message.

			(*MappedAddress) AddToAs(m *Message, t AttrType) error
				AddToAs adds MAPPED-ADDRESS value to m as t attribute.

			(*MappedAddress) GetFrom(m *Message) error
				GetFrom decodes MAPPED-ADDRESS from message.

			(*MappedAddress) GetFromAs(m *Message, t AttrType) error
				GetFromAs decodes MAPPED-ADDRESS value in message m as an attribute of type t.

			( MappedAddress) String() string
		Implements (at least 4)
			*MappedAddress : Getter
			*MappedAddress : Setter
			 MappedAddress : expvar.Var
			 MappedAddress : fmt.Stringer

	 type Message (struct)
		Message represents a single STUN packet. It uses aggressive internal
		buffering to enable zero-allocation encoding and decoding,
		so there are some usage constraints:
		
			Message, its fields, results of m.Get or any attribute a.GetFrom
			are valid only until Message.Raw is not modified.

		Fields (total 5)
			Attributes Attributes
			Length uint32
				// len(Raw) not including header

			Raw []byte
			TransactionID [12]byte
			Type MessageType
		Methods (total 28)
			(*Message) Add(t AttrType, v []byte)
				Add appends new attribute to message. Not goroutine-safe.
				
				Value of attribute is copied to internal buffer so
				it is safe to reuse v.

			(*Message) AddTo(b *Message) error
				AddTo sets b.TransactionID to m.TransactionID.
				
				Implements Setter to aid in crafting responses.

			(*Message) Build(setters ...Setter) error
				Build resets message and applies setters to it in batch, returning on
				first error. To prevent allocations, pass pointers to values.
				
				Example:
				
					var (
						t        = BindingRequest
						username = NewUsername("username")
						nonce    = NewNonce("nonce")
						realm    = NewRealm("example.org")
					)
					m := new(Message)
					m.Build(t, username, nonce, realm)     // 4 allocations
					m.Build(&t, &username, &nonce, &realm) // 0 allocations
				
				See BenchmarkBuildOverhead.

			(*Message) Check(checkers ...Checker) error
				Check applies checkers to message in batch, returning on first error.

			(*Message) CloneTo(b *Message) error
				CloneTo clones m to b securing any further m mutations.

			(*Message) Contains(t AttrType) bool
				Contains return true if message contain t attribute.

			(*Message) Decode() error
				Decode decodes m.Raw into m.

			(*Message) Encode()
				Encode re-encodes message into m.Raw.

			(*Message) Equal(b *Message) bool
				Equal returns true if Message b equals to m.
				Ignores m.Raw.

			(*Message) ForEach(t AttrType, f func(m *Message) error) error
				ForEach is helper that iterates over message attributes allowing to call
				Getter in f callback to get all attributes of type t and returning on first
				f error.
				
				The m.Get method inside f will be returning next attribute on each f call.
				Does not error if there are no results.

			(*Message) Get(t AttrType) ([]byte, error)
				Get returns byte slice that represents attribute value,
				if there is no attribute with such type,
				ErrAttributeNotFound is returned.

			(*Message) GobDecode(data []byte) error
				GobDecode implements the gob.GobDecoder interface.

			( Message) GobEncode() ([]byte, error)
				GobEncode implements the gob.GobEncoder interface.

			( Message) MarshalBinary() (data []byte, err error)
				MarshalBinary implements the encoding.BinaryMarshaler interface.

			(*Message) NewTransactionID() error
				NewTransactionID sets m.TransactionID to random value from crypto/rand
				and returns error if any.

			(*Message) Parse(getters ...Getter) error
				Parse applies getters to message in batch, returning on first error.

			(*Message) ReadFrom(r io.Reader) (int64, error)
				ReadFrom implements ReaderFrom. Reads message from r into m.Raw,
				Decodes it and return error if any. If m.Raw is too small, will return
				ErrUnexpectedEOF, ErrUnexpectedHeaderEOF or *DecodeErr.
				
				Can return *DecodeErr while decoding too.

			(*Message) Reset()
				Reset resets Message, attributes and underlying buffer length.

			(*Message) SetType(t MessageType)
				SetType sets m.Type and writes it to m.Raw.

			(*Message) String() string
			(*Message) UnmarshalBinary(data []byte) error
				UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

			(*Message) Write(tBuf []byte) (int, error)
				Write decodes message and return error if any.
				
				Any error is unrecoverable, but message could be partially decoded.

			(*Message) WriteAttributes()
				WriteAttributes encodes all m.Attributes to m.

			(*Message) WriteHeader()
				WriteHeader writes header to underlying buffer. Not goroutine-safe.

			(*Message) WriteLength()
				WriteLength writes m.Length to m.Raw.

			(*Message) WriteTo(w io.Writer) (int64, error)
				WriteTo implements WriterTo via calling Write(m.Raw) on w and returning
				call result.

			(*Message) WriteTransactionID()
				WriteTransactionID writes m.TransactionID to m.Raw.

			(*Message) WriteType()
				WriteType writes m.Type to m.Raw.

		Implements (at least 13)
			*Message : Setter
			*Message : github.com/gobwas/ws.HandshakeHeader
			*Message : github.com/miekg/dns.Writer
			 Message : encoding.BinaryMarshaler
			*Message : encoding.BinaryUnmarshaler
			*Message : encoding/gob.GobDecoder
			 Message : encoding/gob.GobEncoder
			*Message : expvar.Var
			*Message : fmt.Stringer
			*Message : internal/bisect.Writer
			*Message : io.ReaderFrom
			*Message : io.Writer
			*Message : io.WriterTo
		As Outputs Of (at least 3)
			func Build(setters ...Setter) (*Message, error)
			func MustBuild(setters ...Setter) *Message
			func New() *Message
		As Inputs Of (at least 83)
			func Decode(data []byte, m *Message) error
			func (*Agent).Process(m *Message) error
			func (*AlternateServer).AddTo(m *Message) error
			func (*AlternateServer).GetFrom(m *Message) error
			func Checker.Check(m *Message) error
			func (*Client).Do(m *Message, f func(Event)) error
			func (*Client).Indicate(m *Message) error
			func (*Client).Start(m *Message, h Handler) error
			func ClientAgent.Process(*Message) error
			func ErrorCode.AddTo(m *Message) error
			func ErrorCodeAttribute.AddTo(m *Message) error
			func (*ErrorCodeAttribute).GetFrom(m *Message) error
			func FingerprintAttr.AddTo(m *Message) error
			func FingerprintAttr.Check(m *Message) error
			func Getter.GetFrom(m *Message) error
			func (*MappedAddress).AddTo(m *Message) error
			func (*MappedAddress).AddToAs(m *Message, t AttrType) error
			func (*MappedAddress).GetFrom(m *Message) error
			func (*MappedAddress).GetFromAs(m *Message, t AttrType) error
			func (*Message).AddTo(b *Message) error
			func (*Message).CloneTo(b *Message) error
			func (*Message).Equal(b *Message) bool
			func MessageIntegrity.AddTo(m *Message) error
			func MessageIntegrity.Check(m *Message) error
			func MessageType.AddTo(m *Message) error
			func Nonce.AddTo(m *Message) error
			func (*Nonce).GetFrom(m *Message) error
			func (*OtherAddress).AddTo(m *Message) error
			func (*OtherAddress).GetFrom(m *Message) error
			func RawAttribute.AddTo(m *Message) error
			func Realm.AddTo(m *Message) error
			func (*Realm).GetFrom(m *Message) error
			func (*ResponseOrigin).AddTo(m *Message) error
			func (*ResponseOrigin).GetFrom(m *Message) error
			func Setter.AddTo(m *Message) error
			func Software.AddTo(m *Message) error
			func (*Software).GetFrom(m *Message) error
			func TextAttribute.AddToAs(m *Message, t AttrType, maxLen int) error
			func (*TextAttribute).GetFromAs(m *Message, t AttrType) error
			func UnknownAttributes.AddTo(m *Message) error
			func (*UnknownAttributes).GetFrom(m *Message) error
			func Username.AddTo(m *Message) error
			func (*Username).GetFrom(m *Message) error
			func XORMappedAddress.AddTo(m *Message) error
			func XORMappedAddress.AddToAs(m *Message, t AttrType) error
			func (*XORMappedAddress).GetFrom(m *Message) error
			func (*XORMappedAddress).GetFromAs(m *Message, t AttrType) error
			func github.com/pion/ice/v4.AttrControl.AddTo(m *Message) error
			func github.com/pion/ice/v4.(*AttrControl).GetFrom(m *Message) error
			func github.com/pion/ice/v4.AttrControlled.AddTo(m *Message) error
			func github.com/pion/ice/v4.(*AttrControlled).GetFrom(m *Message) error
			func github.com/pion/ice/v4.AttrControlling.AddTo(m *Message) error
			func github.com/pion/ice/v4.(*AttrControlling).GetFrom(m *Message) error
			func github.com/pion/ice/v4.PriorityAttr.AddTo(m *Message) error
			func github.com/pion/ice/v4.(*PriorityAttr).GetFrom(m *Message) error
			func github.com/pion/ice/v4.UseCandidateAttr.AddTo(m *Message) error
			func github.com/pion/ice/v4.UseCandidateAttr.IsSet(m *Message) bool
			func github.com/pion/ice/v4/internal/stun.AssertUsername(m *Message, expectedUsername string) error
			func github.com/pion/turn/v4.(*Client).PerformTransaction(msg *Message, to net.Addr, ignoreResult bool) (client.TransactionResult, error)
			func github.com/pion/turn/v4/internal/client.Client.PerformTransaction(msg *Message, to net.Addr, dontWait bool) (client.TransactionResult, error)
			func github.com/pion/turn/v4/internal/proto.ChannelNumber.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*ChannelNumber).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.ConnectionID.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*ConnectionID).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.Data.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*Data).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.DontFragment.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*DontFragment).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.DontFragment.IsSet(m *Message) bool
			func github.com/pion/turn/v4/internal/proto.EvenPort.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*EvenPort).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.Lifetime.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*Lifetime).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.PeerAddress.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*PeerAddress).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.RelayedAddress.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*RelayedAddress).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.RequestedAddressFamily.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*RequestedAddressFamily).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.RequestedTransport.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*RequestedTransport).GetFrom(m *Message) error
			func github.com/pion/turn/v4/internal/proto.ReservationToken.AddTo(m *Message) error
			func github.com/pion/turn/v4/internal/proto.(*ReservationToken).GetFrom(m *Message) error

	 type MessageClass byte (basic type)
		MessageClass is 8-bit representation of 2-bit class of STUN Message Class.

		Methods (only one)
			( MessageClass) String() string
		Implements (at least 2)
			 MessageClass : expvar.Var
			 MessageClass : fmt.Stringer
		As Inputs Of (at least one exported)
			func NewType(method Method, class MessageClass) MessageType
		As Types Of (total 4)
			const ClassErrorResponse
			const ClassIndication
			const ClassRequest
			const ClassSuccessResponse

	 type MessageIntegrity ([])
		MessageIntegrity represents MESSAGE-INTEGRITY attribute.
		
		AddTo and Check methods are using zero-allocation version of hmac, see
		newHMAC function and internal/hmac/pool.go.
		
		RFC 5389 Section 15.4

		Methods (total 3)
			( MessageIntegrity) AddTo(m *Message) error
				AddTo adds MESSAGE-INTEGRITY attribute to message.
				
				CPU costly, see BenchmarkMessageIntegrity_AddTo.

			( MessageIntegrity) Check(m *Message) error
				Check checks MESSAGE-INTEGRITY attribute.
				
				CPU costly, see BenchmarkMessageIntegrity_Check.

			( MessageIntegrity) String() string
		Implements (at least 4)
			 MessageIntegrity : Checker
			 MessageIntegrity : Setter
			 MessageIntegrity : expvar.Var
			 MessageIntegrity : fmt.Stringer
		As Outputs Of (at least 2)
			func NewLongTermIntegrity(username, realm, password string) MessageIntegrity
			func NewShortTermIntegrity(password string) MessageIntegrity

	 type MessageType (struct)
		MessageType is STUN Message Type Field.

		Fields (total 2)
			Class MessageClass
				// e.g. request

			Method Method
				// e.g. binding

		Methods (total 4)
			( MessageType) AddTo(m *Message) error
				AddTo sets m type to t.

			(*MessageType) ReadValue(v uint16)
				ReadValue decodes uint16 into MessageType.

			( MessageType) String() string
			( MessageType) Value() uint16
				Value returns bit representation of messageType.

		Implements (at least 3)
			 MessageType : Setter
			 MessageType : expvar.Var
			 MessageType : fmt.Stringer
		As Outputs Of (at least 5)
			func NewType(method Method, class MessageClass) MessageType
			func github.com/pion/turn/v4/internal/proto.AllocateRequest() MessageType
			func github.com/pion/turn/v4/internal/proto.CreatePermissionRequest() MessageType
			func github.com/pion/turn/v4/internal/proto.RefreshRequest() MessageType
			func github.com/pion/turn/v4/internal/proto.SendIndication() MessageType
		As Inputs Of (at least one exported)
			func (*Message).SetType(t MessageType)
		As Types Of (total 3)
			  var BindingError
			  var BindingRequest
			  var BindingSuccess

	 type Method uint16 (basic type)
		Method is uint16 representation of 12-bit STUN method.

		Methods (only one)
			( Method) String() string
		Implements (at least 2)
			 Method : expvar.Var
			 Method : fmt.Stringer
		As Inputs Of (at least one exported)
			func NewType(method Method, class MessageClass) MessageType
		As Types Of (total 10)
			const MethodAllocate
			const MethodBinding
			const MethodChannelBind
			const MethodConnect
			const MethodConnectionAttempt
			const MethodConnectionBind
			const MethodCreatePermission
			const MethodData
			const MethodRefresh
			const MethodSend

	 type Nonce ([])
		Nonce represents NONCE attribute.
		
		RFC 5389 Section 15.8

		Methods (total 3)
			( Nonce) AddTo(m *Message) error
				AddTo adds NONCE to message.

			(*Nonce) GetFrom(m *Message) error
				GetFrom gets NONCE from message.

			( Nonce) String() string
		Implements (at least 4)
			*Nonce : Getter
			 Nonce : Setter
			 Nonce : expvar.Var
			 Nonce : fmt.Stringer
		As Outputs Of (at least one exported)
			func NewNonce(nonce string) Nonce

	 type OtherAddress (struct)
		OtherAddress represents OTHER-ADDRESS attribute.
		
		RFC 5780 Section 7.4

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 3)
			(*OtherAddress) AddTo(m *Message) error
				AddTo adds OTHER-ADDRESS attribute to message.

			(*OtherAddress) GetFrom(m *Message) error
				GetFrom decodes OTHER-ADDRESS from message.

			( OtherAddress) String() string
		Implements (at least 4)
			*OtherAddress : Getter
			*OtherAddress : Setter
			 OtherAddress : expvar.Var
			 OtherAddress : fmt.Stringer

	 type ProtoType int (basic type)
		ProtoType indicates the transport protocol type that is used in the ice.URL
		structure.

		Methods (only one)
			( ProtoType) String() string
		Implements (at least 2)
			 ProtoType : expvar.Var
			 ProtoType : fmt.Stringer
		As Outputs Of (at least one exported)
			func NewProtoType(raw string) ProtoType
		As Types Of (total 5)
			const ProtoTypeTCP
			const ProtoTypeUDP
			const ProtoTypeUnknown
			const github.com/pion/ice/v4.ProtoTypeTCP
			const github.com/pion/ice/v4.ProtoTypeUDP

	 type RawAttribute (struct)
		RawAttribute is a Type-Length-Value (TLV) object that
		can be added to a STUN message. Attributes are divided into two
		types: comprehension-required and comprehension-optional.  STUN
		agents can safely ignore comprehension-optional attributes they
		don't understand, but cannot successfully process a message if it
		contains comprehension-required attributes that are not
		understood.

		Fields (total 3)
			Length uint16
				// ignored while encoding

			Type AttrType
			Value []byte
		Methods (total 3)
			( RawAttribute) AddTo(m *Message) error
				AddTo implements Setter, adding attribute as a.Type with a.Value and ignoring
				the Length field.

			( RawAttribute) Equal(b RawAttribute) bool
				Equal returns true if a == b.

			( RawAttribute) String() string
		Implements (at least 3)
			 RawAttribute : Setter
			 RawAttribute : expvar.Var
			 RawAttribute : fmt.Stringer
		As Outputs Of (at least one exported)
			func Attributes.Get(t AttrType) (RawAttribute, bool)
		As Inputs Of (at least one exported)
			func RawAttribute.Equal(b RawAttribute) bool

	 type Realm ([])
		Realm represents REALM attribute.
		
		RFC 5389 Section 15.7

		Methods (total 3)
			( Realm) AddTo(m *Message) error
				AddTo adds NONCE to message.

			(*Realm) GetFrom(m *Message) error
				GetFrom gets REALM from message.

			( Realm) String() string
		Implements (at least 4)
			*Realm : Getter
			 Realm : Setter
			 Realm : expvar.Var
			 Realm : fmt.Stringer
		As Outputs Of (at least 2)
			func NewRealm(realm string) Realm
			func github.com/pion/turn/v4.(*Client).Realm() Realm

	 type ResponseOrigin (struct)
		ResponseOrigin represents RESPONSE-ORIGIN attribute.
		
		RFC 5780 Section 7.3

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 3)
			(*ResponseOrigin) AddTo(m *Message) error
				AddTo adds RESPONSE-ORIGIN attribute to message.

			(*ResponseOrigin) GetFrom(m *Message) error
				GetFrom decodes RESPONSE-ORIGIN from message.

			( ResponseOrigin) String() string
		Implements (at least 4)
			*ResponseOrigin : Getter
			*ResponseOrigin : Setter
			 ResponseOrigin : expvar.Var
			 ResponseOrigin : fmt.Stringer

	 type SchemeType int (basic type)
		SchemeType indicates the type of server used in the ice.URL structure.

		Methods (only one)
			( SchemeType) String() string
		Implements (at least 2)
			 SchemeType : expvar.Var
			 SchemeType : fmt.Stringer
		As Outputs Of (at least one exported)
			func NewSchemeType(raw string) SchemeType
		As Types Of (total 9)
			const SchemeTypeSTUN
			const SchemeTypeSTUNS
			const SchemeTypeTURN
			const SchemeTypeTURNS
			const SchemeTypeUnknown
			const github.com/pion/ice/v4.SchemeTypeSTUN
			const github.com/pion/ice/v4.SchemeTypeSTUNS
			const github.com/pion/ice/v4.SchemeTypeTURN
			const github.com/pion/ice/v4.SchemeTypeTURNS

	 type Setter (interface)
		Setter sets *Message attribute.

		Methods (only one)
			( Setter) AddTo(m *Message) error
		Implemented By (at least 33)
			*AlternateServer
			 ErrorCode
			 ErrorCodeAttribute
			 FingerprintAttr
			*MappedAddress
			*Message
			 MessageIntegrity
			 MessageType
			 Nonce
			*OtherAddress
			 RawAttribute
			 Realm
			*ResponseOrigin
			 Software
			 UnknownAttributes
			 Username
			 XORMappedAddress
			 github.com/pion/ice/v4.AttrControl
			 github.com/pion/ice/v4.AttrControlled
			 github.com/pion/ice/v4.AttrControlling
			 github.com/pion/ice/v4.PriorityAttr
			 github.com/pion/ice/v4.UseCandidateAttr
			 github.com/pion/turn/v4/internal/proto.ChannelNumber
			 github.com/pion/turn/v4/internal/proto.ConnectionID
			 github.com/pion/turn/v4/internal/proto.Data
			 github.com/pion/turn/v4/internal/proto.DontFragment
			 github.com/pion/turn/v4/internal/proto.EvenPort
			 github.com/pion/turn/v4/internal/proto.Lifetime
			 github.com/pion/turn/v4/internal/proto.PeerAddress
			 github.com/pion/turn/v4/internal/proto.RelayedAddress
			 github.com/pion/turn/v4/internal/proto.RequestedAddressFamily
			 github.com/pion/turn/v4/internal/proto.RequestedTransport
			 github.com/pion/turn/v4/internal/proto.ReservationToken
		As Outputs Of (at least 2)
			func NewTransactionIDSetter(value [12]byte) Setter
			func github.com/pion/turn/v4/internal/allocation.(*Allocation).GetResponseCache() (id [12]byte, attrs []Setter)
		As Inputs Of (at least 4)
			func Build(setters ...Setter) (*Message, error)
			func MustBuild(setters ...Setter) *Message
			func (*Message).Build(setters ...Setter) error
			func github.com/pion/turn/v4/internal/allocation.(*Allocation).SetResponseCache(transactionID [12]byte, attrs []Setter)
		As Types Of (only one)
			  var TransactionID

	 type Software ([])
		Software is SOFTWARE attribute.
		
		RFC 5389 Section 15.10

		Methods (total 3)
			( Software) AddTo(m *Message) error
				AddTo adds Software attribute to m.

			(*Software) GetFrom(m *Message) error
				GetFrom decodes Software from m.

			( Software) String() string
		Implements (at least 4)
			*Software : Getter
			 Software : Setter
			 Software : expvar.Var
			 Software : fmt.Stringer
		As Outputs Of (at least one exported)
			func NewSoftware(software string) Software

	 type StopErr (struct)
		StopErr occurs when Client fails to stop transaction while
		processing error.

		Fields (total 2)
			Cause error
				// error that caused Stop() call

			Err error
				// value returned by Stop()

		Methods (only one)
			( StopErr) Error() string
		Implements (at least one exported)
			 StopErr : error

	 type TextAttribute ([])
		TextAttribute is helper for adding and getting text attributes.

		Methods (total 2)
			( TextAttribute) AddToAs(m *Message, t AttrType, maxLen int) error
				AddToAs adds attribute with type t to m, checking maximum length. If maxLen
				is less than 0, no check is performed.

			(*TextAttribute) GetFromAs(m *Message, t AttrType) error
				GetFromAs gets t attribute from m and appends its value to reseted v.


	 type UnknownAttributes ([])
		UnknownAttributes represents UNKNOWN-ATTRIBUTES attribute.
		
		RFC 5389 Section 15.9

		Methods (total 3)
			( UnknownAttributes) AddTo(m *Message) error
				AddTo adds UNKNOWN-ATTRIBUTES attribute to message.

			(*UnknownAttributes) GetFrom(m *Message) error
				GetFrom parses UNKNOWN-ATTRIBUTES from message.

			( UnknownAttributes) String() string
		Implements (at least 4)
			*UnknownAttributes : Getter
			 UnknownAttributes : Setter
			 UnknownAttributes : expvar.Var
			 UnknownAttributes : fmt.Stringer

	 type URI (struct)
		URI represents a STUN (rfc7064) or TURN (rfc7065) URI

		Fields (total 6)
			Host string
			Password string
			Port int
			Proto ProtoType
			Scheme SchemeType
			Username string
		Methods (total 2)
			( URI) IsSecure() bool
				IsSecure returns whether the this URL's scheme describes secure scheme or not.

			( URI) String() string
		Implements (at least 2)
			 URI : expvar.Var
			 URI : fmt.Stringer
		As Outputs Of (at least one exported)
			func ParseURI(raw string) (*URI, error)
		As Inputs Of (at least one exported)
			func DialURI(uri *URI, cfg *DialConfig) (*Client, error)

	 type Username ([])
		Username represents USERNAME attribute.
		
		RFC 5389 Section 15.3

		Methods (total 3)
			( Username) AddTo(m *Message) error
				AddTo adds USERNAME attribute to message.

			(*Username) GetFrom(m *Message) error
				GetFrom gets USERNAME from message.

			( Username) String() string
		Implements (at least 4)
			*Username : Getter
			 Username : Setter
			 Username : expvar.Var
			 Username : fmt.Stringer
		As Outputs Of (at least 2)
			func NewUsername(username string) Username
			func github.com/pion/turn/v4.(*Client).Username() Username

	 type XORMappedAddress (struct)
		XORMappedAddress implements XOR-MAPPED-ADDRESS attribute.
		
		RFC 5389 Section 15.2

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 5)
			( XORMappedAddress) AddTo(m *Message) error
				AddTo adds XOR-MAPPED-ADDRESS to m. Can return ErrBadIPLength
				if len(a.IP) is invalid.

			( XORMappedAddress) AddToAs(m *Message, t AttrType) error
				AddToAs adds XOR-MAPPED-ADDRESS value to m as t attribute.

			(*XORMappedAddress) GetFrom(m *Message) error
				GetFrom decodes XOR-MAPPED-ADDRESS attribute in message and returns
				error if any. While decoding, a.IP is reused if possible and can be
				rendered to invalid state (e.g. if a.IP was set to IPv6 and then
				IPv4 value were decoded into it), be careful.
				
				Example:
				
					expectedIP := net.ParseIP("213.141.156.236")
					expectedIP.String() // 213.141.156.236, 16 bytes, first 12 of them are zeroes
					expectedPort := 21254
					addr := &XORMappedAddress{
					  IP:   expectedIP,
					  Port: expectedPort,
					}
					// addr were added to message that is decoded as newMessage
					// ...
				
					addr.GetFrom(newMessage)
					addr.IP.String()    // 213.141.156.236, net.IPv4Len
					expectedIP.String() // d58d:9cec::ffff:d58d:9cec, 16 bytes, first 4 are IPv4
					// now we have len(expectedIP) = 16 and len(addr.IP) = 4.

			(*XORMappedAddress) GetFromAs(m *Message, t AttrType) error
				GetFromAs decodes XOR-MAPPED-ADDRESS attribute value in message
				getting it as for t type.

			( XORMappedAddress) String() string
		Implements (at least 4)
			*XORMappedAddress : Getter
			 XORMappedAddress : Setter
			 XORMappedAddress : expvar.Var
			 XORMappedAddress : fmt.Stringer
		As Outputs Of (at least 3)
			func github.com/pion/ice/v4.UniversalUDPMux.GetXORMappedAddr(stunAddr net.Addr, deadline time.Duration) (*XORMappedAddress, error)
			func github.com/pion/ice/v4.(*UniversalUDPMuxDefault).GetXORMappedAddr(serverAddr net.Addr, deadline time.Duration) (*XORMappedAddress, error)
			func github.com/pion/ice/v4/internal/stun.GetXORMappedAddr(conn net.PacketConn, serverAddr net.Addr, timeout time.Duration) (*XORMappedAddress, error)


Package-Level Functions (total 35)

	 func Build(setters ...Setter) (*Message, error)
		Build wraps Message.Build method.

	 func CheckOverflow(_ AttrType, got, max int) error
		CheckOverflow returns ErrAttributeSizeOverflow if got is bigger that max.

	 func CheckSize(_ AttrType, got, expected int) error
		CheckSize returns ErrAttrSizeInvalid if got is not equal to expected.

	 func Decode(data []byte, m *Message) error
		Decode decodes Message from data to m, returning error if any.

	 func Dial(network, address string) (*Client, error)
		Dial connects to the address on the named network and then
		initializes Client on that connection, returning error if any.

	 func DialURI(uri *URI, cfg *DialConfig) (*Client, error)
		DialURI connect to the STUN/TURN URI and then
		initializes Client on that connection, returning error if any.

	 func FingerprintValue(b []byte) uint32
		FingerprintValue returns CRC-32 of b XOR-ed by 0x5354554e.
		
		The value of the attribute is computed as the CRC-32 of the STUN message
		up to (but excluding) the FINGERPRINT attribute itself, XOR'ed with
		the 32-bit value 0x5354554e (the XOR helps in cases where an
		application packet is also using CRC-32 in it).

	 func IsAttrSizeInvalid(err error) bool
		IsAttrSizeInvalid returns true if error means that attribute size is invalid.

	 func IsAttrSizeOverflow(err error) bool
		IsAttrSizeOverflow returns true if error means that attribute size is too big.

	 func IsMessage(b []byte) bool
		IsMessage returns true if b looks like STUN message.
		Useful for multiplexing. IsMessage does not guarantee
		that decoding will be successful.

	 func MustBuild(setters ...Setter) *Message
		MustBuild wraps Build call and panics on error.

	 func New() *Message
		New returns *Message with pre-allocated Raw.

	 func NewAgent(h Handler) *Agent
		NewAgent initializes and returns new Agent with provided handler.
		If h is nil, the NoopHandler will be used.

	 func NewClient(conn Connection, options ...ClientOption) (*Client, error)
		NewClient initializes new Client from provided options,
		starting internal goroutines and using default options fields
		if necessary. Call Close method after using Client to close conn and
		release resources.
		
		The conn will be closed on Close call. Use WithNoConnClose option to
		prevent that.
		
		Note that user should handle the protocol multiplexing, client does not
		provide any API for it, so if you need to read application data, wrap the
		connection with your (de-)multiplexer and pass the wrapper as conn.

	 func NewLongTermIntegrity(username, realm, password string) MessageIntegrity
		NewLongTermIntegrity returns new MessageIntegrity with key for long-term
		credentials. Password, username, and realm must be SASL-prepared.

	 func NewNonce(nonce string) Nonce
		NewNonce returns new Nonce from string.

	 func NewProtoType(raw string) ProtoType
		NewProtoType defines a procedure for creating a new ProtoType from a raw
		string naming the transport protocol type.

	 func NewRealm(realm string) Realm
		NewRealm returns Realm with provided value.
		Must be SASL-prepared.

	 func NewSchemeType(raw string) SchemeType
		NewSchemeType defines a procedure for creating a new SchemeType from a raw
		string naming the scheme type.

	 func NewShortTermIntegrity(password string) MessageIntegrity
		NewShortTermIntegrity returns new MessageIntegrity with key for short-term
		credentials. Password must be SASL-prepared.

	 func NewSoftware(software string) Software
		NewSoftware returns *Software from string.

	 func NewTransactionID() (b [12]byte)
		NewTransactionID returns new random transaction ID using crypto/rand
		as source.

	 func NewTransactionIDSetter(value [12]byte) Setter
		NewTransactionIDSetter returns new Setter that sets message transaction id
		to provided value.

	 func NewType(method Method, class MessageClass) MessageType
		NewType returns new message type with provided method and class.

	 func NewUsername(username string) Username
		NewUsername returns Username with provided value.

	 func NoopHandler() Handler
		NoopHandler just discards any event.

	 func ParseURI(raw string) (*URI, error)
		ParseURI parses a STUN or TURN urls following the ABNF syntax described in
		https://tools.ietf.org/html/rfc7064 and https://tools.ietf.org/html/rfc7065
		respectively.

	 func WithAgent(a ClientAgent) ClientOption
		WithAgent sets client STUN agent.
		
		Defaults to agent implementation in current package,
		see agent.go.

	 func WithClock(clock Clock) ClientOption
		WithClock sets Clock of client, the source of current time.
		Also clock is passed to default collector if set.

	 func WithCollector(coll Collector) ClientOption
		WithCollector rests client timeout collector, the implementation
		of ticker which calls function on each tick.

	 func WithHandler(h Handler) ClientOption
		WithHandler sets client handler which is called if Agent emits the Event
		with TransactionID that is not currently registered by Client.
		Useful for handling Data indications from TURN server.

	 func WithNoConnClose() ClientOption
		WithNoConnClose prevents client from closing underlying connection when
		the Close() method is called.

	 func WithNoRetransmit(c *Client)
		WithNoRetransmit disables retransmissions and sets RTO to
		defaultMaxAttempts * defaultRTO which will be effectively time out
		if not set.
		
		Useful for TCP connections where transport handles RTO.

	 func WithRTO(rto time.Duration) ClientOption
		WithRTO sets client RTO as defined in STUN RFC.

	 func WithTimeoutRate(d time.Duration) ClientOption
		WithTimeoutRate sets RTO timer minimum resolution.


Package-Level Variables (total 32)

	  var BindingError MessageType
		Binding error response message type.

	  var BindingRequest MessageType
		Binding request message type.

	  var BindingSuccess MessageType
		Binding success response message type

	  var ErrAgentClosed error
		ErrAgentClosed indicates that agent is in closed state and is unable
		to handle transactions.

	  var ErrAttributeNotFound error
		ErrAttributeNotFound means that attribute with provided attribute
		type does not exist in message.

	  var ErrAttributeSizeInvalid error
		ErrAttributeSizeInvalid means that decoded attribute size is invalid.

	  var ErrAttributeSizeOverflow error
		ErrAttributeSizeOverflow means that decoded attribute size is too big.

	  var ErrBadIPLength error
		ErrBadIPLength means that len(IP) is not net.{IPv6len,IPv4len}.

	  var ErrBadUnknownAttrsSize error
		ErrBadUnknownAttrsSize means that UNKNOWN-ATTRIBUTES attribute value
		has invalid length.

	  var ErrClientClosed error
		ErrClientClosed indicates that client is closed.

	  var ErrClientNotInitialized error
		ErrClientNotInitialized means that client connection or agent is nil.

	  var ErrDecodeToNil error
		ErrDecodeToNil occurs on Decode(data, nil) call.

	  var ErrFingerprintBeforeIntegrity error
		ErrFingerprintBeforeIntegrity means that FINGERPRINT attribute is already in
		message, so MESSAGE-INTEGRITY attribute cannot be added.

	  var ErrFingerprintMismatch error
		ErrFingerprintMismatch means that computed fingerprint differs from expected.

	  var ErrHost error
		ErrHost indicates malformed hostname is provided.

	  var ErrIntegrityMismatch error
		ErrIntegrityMismatch means that computed HMAC differs from expected.

	  var ErrInvalidQuery error
		ErrInvalidQuery indicates an malformed query is provided.

	  var ErrNoConnection error
		ErrNoConnection means that ClientOptions.Connection is nil.

	  var ErrNoDefaultReason error
		ErrNoDefaultReason means that default reason for provided error code
		is not defined in RFC.

	  var ErrPort error
		ErrPort indicates malformed port is provided.

	  var ErrProtoType error
		ErrProtoType indicates an unsupported transport type was provided.

	  var ErrSchemeType error
		ErrSchemeType indicates the scheme type could not be parsed.

	  var ErrSTUNQuery error
		ErrSTUNQuery indicates query arguments are provided in a STUN URL.

	  var ErrTransactionExists error
		ErrTransactionExists indicates that transaction with same id is already
		registered.

	  var ErrTransactionNotExists error
		ErrTransactionNotExists indicates that agent failed to find transaction.

	  var ErrTransactionStopped error
		ErrTransactionStopped indicates that transaction was manually stopped.

	  var ErrTransactionTimeOut error
		ErrTransactionTimeOut indicates that transaction has reached deadline.

	  var ErrUnexpectedHeaderEOF error
		ErrUnexpectedHeaderEOF means that there were not enough bytes in
		m.Raw to read header.

	  var ErrUnknownType error
		ErrUnknownType indicates an error with Unknown info.

	  var ErrUnsupportedURI error
		ErrUnsupportedURI is an error thrown if the user passes an unsupported STUN or TURN URI

	  var Fingerprint FingerprintAttr
		Fingerprint is shorthand for FingerprintAttr.
		
		Example:
		
			m := New()
			Fingerprint.AddTo(m)

	  var TransactionID Setter
		TransactionID is Setter for m.TransactionID.


Package-Level Constants (total 83)

	const AttrAlternateDomain AttrType = 32771 // ALTERNATE-DOMAIN
		Attributes from RFC 8489 STUN.

	const AttrAlternateServer AttrType = 32803 // ALTERNATE-SERVER
		Attributes from comprehension-optional range (0x8000-0xFFFF).

	const AttrCacheTimeout AttrType = 32807 // CACHE-TIMEOUT
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrChangedAddress AttrType = 5 // CHANGED-ADDRESS
		Attributes from RFC 3489, removed by RFC 5389,
		
			but still used by RFC5389-implementing software like Vovida.org, reTURNServer, etc.

	const AttrChangeRequest AttrType = 3 // CHANGE-REQUEST
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrChannelNumber AttrType = 12 // CHANNEL-NUMBER
		Attributes from RFC 5766 TURN.

	const AttrConnectionID AttrType = 42 // CONNECTION-ID
		Attributes from RFC 6062 TURN Extensions for TCP Allocations.

	const AttrData AttrType = 19 // DATA
		Attributes from RFC 5766 TURN.

	const AttrDontFragment AttrType = 26 // DONT-FRAGMENT
		Attributes from RFC 5766 TURN.

	const AttrErrorCode AttrType = 9 // ERROR-CODE
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrEvenPort AttrType = 24 // EVEN-PORT
		Attributes from RFC 5766 TURN.

	const AttrFingerprint AttrType = 32808 // FINGERPRINT
		Attributes from comprehension-optional range (0x8000-0xFFFF).

	const AttrICEControlled AttrType = 32809 // ICE-CONTROLLED
		Attributes from RFC 5245 ICE.

	const AttrICEControlling AttrType = 32810 // ICE-CONTROLLING
		Attributes from RFC 5245 ICE.

	const AttrLifetime AttrType = 13 // LIFETIME
		Attributes from RFC 5766 TURN.

	const AttrMappedAddress AttrType = 1 // MAPPED-ADDRESS
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrMessageIntegrity AttrType = 8 // MESSAGE-INTEGRITY
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrMessageIntegritySHA256 AttrType = 28 // MESSAGE-INTEGRITY-SHA256
		Attributes from RFC 8489 STUN.

	const AttrNonce AttrType = 21 // NONCE
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrOrigin AttrType = 32815
		Attributes from An Origin Attribute for the STUN Protocol.

	const AttrOtherAddress AttrType = 32812 // OTHER-ADDRESS
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrPadding AttrType = 38 // PADDING
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrPasswordAlgorithm AttrType = 29 // PASSWORD-ALGORITHM
		Attributes from RFC 8489 STUN.

	const AttrPasswordAlgorithms AttrType = 32770 // PASSWORD-ALGORITHMS
		Attributes from RFC 8489 STUN.

	const AttrPriority AttrType = 36 // PRIORITY
		Attributes from RFC 5245 ICE.

	const AttrRealm AttrType = 20 // REALM
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrRequestedAddressFamily AttrType = 23 // REQUESTED-ADDRESS-FAMILY
		Attributes from RFC 6156 TURN IPv6.

	const AttrRequestedTransport AttrType = 25 // REQUESTED-TRANSPORT
		Attributes from RFC 5766 TURN.

	const AttrReservationToken AttrType = 34 // RESERVATION-TOKEN
		Attributes from RFC 5766 TURN.

	const AttrResponseOrigin AttrType = 32811 // RESPONSE-ORIGIN
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrResponsePort AttrType = 39 // RESPONSE-PORT
		Attributes from RFC 5780 NAT Behavior Discovery

	const AttrSoftware AttrType = 32802 // SOFTWARE
		Attributes from comprehension-optional range (0x8000-0xFFFF).

	const AttrSourceAddress AttrType = 4 // SOURCE-ADDRESS
		Attributes from RFC 3489, removed by RFC 5389,
		
			but still used by RFC5389-implementing software like Vovida.org, reTURNServer, etc.

	const AttrUnknownAttributes AttrType = 10 // UNKNOWN-ATTRIBUTES
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrUseCandidate AttrType = 37 // USE-CANDIDATE
		Attributes from RFC 5245 ICE.

	const AttrUserhash AttrType = 30 // USERHASH
		Attributes from RFC 8489 STUN.

	const AttrUsername AttrType = 6 // USERNAME
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrXORMappedAddress AttrType = 32 // XOR-MAPPED-ADDRESS
		Attributes from comprehension-required range (0x0000-0x7FFF).

	const AttrXORPeerAddress AttrType = 18 // XOR-PEER-ADDRESS
		Attributes from RFC 5766 TURN.

	const AttrXORRelayedAddress AttrType = 22 // XOR-RELAYED-ADDRESS
		Attributes from RFC 5766 TURN.

	const ClassErrorResponse MessageClass = 3 // 0b11
		Possible values for message class in STUN Message Type.

	const ClassIndication MessageClass = 1 // 0b01
		Possible values for message class in STUN Message Type.

	const ClassRequest MessageClass = 0 // 0b00
		Possible values for message class in STUN Message Type.

	const ClassSuccessResponse MessageClass = 2 // 0b10
		Possible values for message class in STUN Message Type.

	const CodeAddrFamilyNotSupported ErrorCode = 440 // Address Family not Supported
		Error codes from RFC 6156.
		
		RFC 6156 Section 10.2

	const CodeAllocMismatch ErrorCode = 437 // Allocation Mismatch
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const CodeAllocQuotaReached ErrorCode = 486 // Allocation Quota Reached
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const CodeBadRequest ErrorCode = 400
		Possible error codes.

	const CodeConnAlreadyExists ErrorCode = 446
		Error codes from RFC 6062.
		
		RFC 6062 Section 6.3

	const CodeConnTimeoutOrFailure ErrorCode = 447
		Error codes from RFC 6062.
		
		RFC 6062 Section 6.3

	const CodeForbidden ErrorCode = 403 // Forbidden
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const CodeInsufficientCapacity ErrorCode = 508 // Insufficient Capacity
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const CodePeerAddrFamilyMismatch ErrorCode = 443 // Peer Address Family Mismatch
		Error codes from RFC 6156.
		
		RFC 6156 Section 10.2

	const CodeRoleConflict ErrorCode = 487
		Possible error codes.

	const CodeServerError ErrorCode = 500
		Possible error codes.

	const CodeStaleNonce ErrorCode = 438
		Possible error codes.

	const CodeTryAlternate ErrorCode = 300
		Possible error codes.

	const CodeUnauthorised ErrorCode = 401
		DEPRECATED, use CodeUnauthorized.

	const CodeUnauthorized ErrorCode = 401
		Possible error codes.

	const CodeUnknownAttribute ErrorCode = 420
		Possible error codes.

	const CodeUnsupportedTransProto ErrorCode = 442 // Unsupported Transport Protocol
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const CodeWrongCredentials ErrorCode = 441 // Wrong Credentials
		Error codes from RFC 5766.
		
		RFC 5766 Section 15

	const DefaultPort = 3478
		IANA assigned ports for "stun" protocol.

	const DefaultTLSPort = 5349
		IANA assigned ports for "stun" protocol.

	const MethodAllocate Method = 3
		Possible methods for STUN Message.

	const MethodBinding Method = 1
		Possible methods for STUN Message.

	const MethodChannelBind Method = 9
		Possible methods for STUN Message.

	const MethodConnect Method = 10
		Methods from RFC 6062.

	const MethodConnectionAttempt Method = 12
		Methods from RFC 6062.

	const MethodConnectionBind Method = 11
		Methods from RFC 6062.

	const MethodCreatePermission Method = 8
		Possible methods for STUN Message.

	const MethodData Method = 7
		Possible methods for STUN Message.

	const MethodRefresh Method = 4
		Possible methods for STUN Message.

	const MethodSend Method = 6
		Possible methods for STUN Message.

	const ProtoTypeTCP ProtoType = 2
		ProtoTypeTCP indicates the URL uses a TCP transport.

	const ProtoTypeUDP ProtoType = 1
		ProtoTypeUDP indicates the URL uses a UDP transport.

	const ProtoTypeUnknown ProtoType = 0
		ProtoTypeUnknown indicates an unknown or unsupported protocol.

	const SchemeTypeSTUN SchemeType = 1
		SchemeTypeSTUN indicates the URL represents a STUN server.

	const SchemeTypeSTUNS SchemeType = 2
		SchemeTypeSTUNS indicates the URL represents a STUNS (secure) server.

	const SchemeTypeTURN SchemeType = 3
		SchemeTypeTURN indicates the URL represents a TURN server.

	const SchemeTypeTURNS SchemeType = 4
		SchemeTypeTURNS indicates the URL represents a TURNS (secure) server.

	const SchemeTypeUnknown SchemeType = 0
		SchemeTypeUnknown indicates an unknown or unsupported scheme.

	const TransactionIDSize = 12 // 96 bit
		TransactionIDSize is length of transaction id array (in bytes).

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.