package proto

Import Path
	github.com/pion/turn/v4/internal/proto (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 4 packages

Involved Source Files

	    addr.go
	    chandata.go
	    chann.go
	    connection_id.go
	    data.go
	    dontfrag.go
	    evenport.go
	    lifetime.go
	    peeraddr.go
	  d proto.go
		Package proto implements RFC 5766 Traversal Using Relays around NAT.

	    relayedaddr.go
	    reqfamily.go
	    reqtrans.go
	    rsrvtoken.go
Package-Level Type Names (total 18)

	/* sort by: alphabet | popularity */
	 type Addr (struct)
		Addr is ip:port.

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 5)
			( Addr) Equal(b Addr) bool
				Equal returns true if b == a.

			( Addr) EqualIP(b Addr) bool
				EqualIP returns true if a and b have equal IP addresses.

			(*Addr) FromUDPAddr(n *net.UDPAddr)
				FromUDPAddr sets addr to UDPAddr.

			( Addr) Network() string
				Network implements net.Addr.

			( Addr) String() string
		Implements (at least 3)
			 Addr : expvar.Var
			 Addr : fmt.Stringer
			 Addr : net.Addr
		As Inputs Of (at least 2)
			func Addr.Equal(b Addr) bool
			func Addr.EqualIP(b Addr) bool

	 type ChannelData (struct)
		ChannelData represents The ChannelData Message.
		
		See RFC 5766 Section 11.4.

		Fields (total 4)
			Data []byte
				// Can be sub slice of Raw

			Length int
				// Ignored while encoding, len(Data) is used

			Number ChannelNumber
			Raw []byte
		Methods (total 5)
			(*ChannelData) Decode() error
				Decode decodes The ChannelData Message from Raw.

			(*ChannelData) Encode()
				Encode encodes ChannelData Message to Raw.

			(*ChannelData) Equal(compareTo *ChannelData) bool
				Equal returns true if compareTo == c.

			(*ChannelData) Reset()
				Reset resets Length, Data and Raw length.

			(*ChannelData) WriteHeader()
				WriteHeader writes channel number and length.

		As Inputs Of (at least one exported)
			func (*ChannelData).Equal(compareTo *ChannelData) bool

	 type ChannelNumber uint16 (basic type)
		ChannelNumber represents CHANNEL-NUMBER attribute.
		
		The CHANNEL-NUMBER attribute contains the number of the channel.
		
		RFC 5766 Section 14.1.

		Methods (total 4)
			( ChannelNumber) AddTo(m *stun.Message) error
				AddTo adds CHANNEL-NUMBER to message.

			(*ChannelNumber) GetFrom(m *stun.Message) error
				GetFrom decodes CHANNEL-NUMBER from message.

			( ChannelNumber) String() string
			( ChannelNumber) Valid() bool
				Valid returns true if channel number has correct value that complies RFC 5766 Section 11 range.

		Implements (at least 4)
			*ChannelNumber : github.com/pion/stun/v3.Getter
			 ChannelNumber : github.com/pion/stun/v3.Setter
			 ChannelNumber : expvar.Var
			 ChannelNumber : fmt.Stringer
		As Inputs Of (at least 3)
			func github.com/pion/turn/v4/internal/allocation.NewChannelBind(number ChannelNumber, peer net.Addr, log logging.LeveledLogger) *allocation.ChannelBind
			func github.com/pion/turn/v4/internal/allocation.(*Allocation).GetChannelByNumber(number ChannelNumber) *allocation.ChannelBind
			func github.com/pion/turn/v4/internal/allocation.(*Allocation).RemoveChannelBind(number ChannelNumber) bool

	 type ConnectionID uint32 (basic type)
		ConnectionID represents CONNECTION-ID attribute.
		
		The CONNECTION-ID attribute uniquely identifies a peer data
		connection.  It is a 32-bit unsigned integral value.
		
		RFC 6062 Section 6.2.1.

		Methods (total 2)
			( ConnectionID) AddTo(m *stun.Message) error
				AddTo adds CONNECTION-ID to message.

			(*ConnectionID) GetFrom(m *stun.Message) error
				GetFrom decodes CONNECTION-ID from message.

		Implements (at least 2)
			*ConnectionID : github.com/pion/stun/v3.Getter
			 ConnectionID : github.com/pion/stun/v3.Setter
		As Outputs Of (at least one exported)
			func github.com/pion/turn/v4/internal/client.(*TCPAllocation).Connect(peer net.Addr) (ConnectionID, error)
		As Inputs Of (at least 2)
			func github.com/pion/turn/v4/internal/client.(*TCPAllocation).BindConnection(dataConn *client.TCPConn, cid ConnectionID) error
			func github.com/pion/turn/v4/internal/client.(*TCPAllocation).HandleConnectionAttempt(from *net.TCPAddr, cid ConnectionID)

	 type Data ([])
		Data represents DATA attribute.
		
		The DATA attribute is present in all Send and Data indications.  The
		value portion of this attribute is variable length and consists of
		the application data (that is, the data that would immediately follow
		the UDP header if the data was been sent directly between the client
		and the peer).
		
		RFC 5766 Section 14.4.

		Methods (total 2)
			( Data) AddTo(m *stun.Message) error
				AddTo adds DATA to message.

			(*Data) GetFrom(m *stun.Message) error
				GetFrom decodes DATA from message.

		Implements (at least 2)
			*Data : github.com/pion/stun/v3.Getter
			 Data : github.com/pion/stun/v3.Setter

	 type DontFragment (struct)
		DontFragment represents DONT-FRAGMENT attribute.
		
		This attribute is used by the client to request that the server set
		the DF (Don't Fragment) bit in the IP header when relaying the
		application data onward to the peer.  This attribute has no value
		part and thus the attribute length field is 0.
		
		RFC 5766 Section 14.8.

		Methods (total 3)
			( DontFragment) AddTo(m *stun.Message) error
				AddTo adds DONT-FRAGMENT attribute to message.

			(*DontFragment) GetFrom(m *stun.Message) error
				GetFrom decodes DONT-FRAGMENT from message.

			( DontFragment) IsSet(m *stun.Message) bool
				IsSet returns true if DONT-FRAGMENT attribute is set.

		Implements (at least 2)
			*DontFragment : github.com/pion/stun/v3.Getter
			 DontFragment : github.com/pion/stun/v3.Setter

	 type DontFragmentAttr = DontFragment (struct)
		DontFragmentAttr is a deprecated alias for DontFragment
		Deprecated: Please use DontFragment.

	 type EvenPort (struct)
		EvenPort represents EVEN-PORT attribute.
		
		This attribute allows the client to request that the port in the
		relayed transport address be even, and (optionally) that the server
		reserve the next-higher port number.
		
		RFC 5766 Section 14.6.

		Fields (only one)
			ReservePort bool
				ReservePort means that the server is requested to reserve
				the next-higher port number (on the same IP address)
				for a subsequent allocation.

		Methods (total 3)
			( EvenPort) AddTo(m *stun.Message) error
				AddTo adds EVEN-PORT to message.

			(*EvenPort) GetFrom(m *stun.Message) error
				GetFrom decodes EVEN-PORT from message.

			( EvenPort) String() string
		Implements (at least 4)
			*EvenPort : github.com/pion/stun/v3.Getter
			 EvenPort : github.com/pion/stun/v3.Setter
			 EvenPort : expvar.Var
			 EvenPort : fmt.Stringer

	 type FiveTuple (struct)
		FiveTuple represents 5-TUPLE value.

		Fields (total 3)
			Client Addr
			Proto Protocol
			Server Addr
		Methods (total 2)
			( FiveTuple) Equal(b FiveTuple) bool
				Equal returns true if b == t.

			( FiveTuple) String() string
		Implements (at least 2)
			 FiveTuple : expvar.Var
			 FiveTuple : fmt.Stringer
		As Inputs Of (at least one exported)
			func FiveTuple.Equal(b FiveTuple) bool

	 type Lifetime (struct)
		Lifetime represents LIFETIME attribute.
		
		The LIFETIME attribute represents the duration for which the server
		will maintain an allocation in the absence of a refresh. The value
		portion of this attribute is 4-bytes long and consists of a 32-bit
		unsigned integral value representing the number of seconds remaining
		until expiration.
		
		RFC 5766 Section 14.2.

		Fields (only one)
			Duration time.Duration
		Methods (total 12)
			( Lifetime) Abs() time.Duration
				Abs returns the absolute value of d.
				As a special case, Duration([math.MinInt64]) is converted to Duration([math.MaxInt64]),
				reducing its magnitude by 1 nanosecond.

			( Lifetime) AddTo(m *stun.Message) error
				AddTo adds LIFETIME to message.

			(*Lifetime) GetFrom(m *stun.Message) error
				GetFrom decodes LIFETIME from message.

			( Lifetime) Hours() float64
				Hours returns the duration as a floating point number of hours.

			( Lifetime) Microseconds() int64
				Microseconds returns the duration as an integer microsecond count.

			( Lifetime) Milliseconds() int64
				Milliseconds returns the duration as an integer millisecond count.

			( Lifetime) Minutes() float64
				Minutes returns the duration as a floating point number of minutes.

			( Lifetime) Nanoseconds() int64
				Nanoseconds returns the duration as an integer nanosecond count.

			( Lifetime) Round(m time.Duration) time.Duration
				Round returns the result of rounding d to the nearest multiple of m.
				The rounding behavior for halfway values is to round away from zero.
				If the result exceeds the maximum (or minimum)
				value that can be stored in a [Duration],
				Round returns the maximum (or minimum) duration.
				If m <= 0, Round returns d unchanged.

			( Lifetime) Seconds() float64
				Seconds returns the duration as a floating point number of seconds.

			( Lifetime) String() string
				String returns a string representing the duration in the form "72h3m0.5s".
				Leading zero units are omitted. As a special case, durations less than one
				second format use a smaller unit (milli-, micro-, or nanoseconds) to ensure
				that the leading digit is non-zero. The zero duration formats as 0s.

			( Lifetime) Truncate(m time.Duration) time.Duration
				Truncate returns the result of rounding d toward zero to a multiple of m.
				If m <= 0, Truncate returns d unchanged.

		Implements (at least 4)
			*Lifetime : github.com/pion/stun/v3.Getter
			 Lifetime : github.com/pion/stun/v3.Setter
			 Lifetime : expvar.Var
			 Lifetime : fmt.Stringer

	 type PeerAddress (struct)
		PeerAddress implements XOR-PEER-ADDRESS attribute.
		
		The XOR-PEER-ADDRESS specifies the address and port of the peer as
		seen from the TURN server. (For example, the peer's server-reflexive
		transport address if the peer is behind a NAT.)
		
		RFC 5766 Section 14.3.

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 3)
			( PeerAddress) AddTo(m *stun.Message) error
				AddTo adds XOR-PEER-ADDRESS to message.

			(*PeerAddress) GetFrom(m *stun.Message) error
				GetFrom decodes XOR-PEER-ADDRESS from message.

			( PeerAddress) String() string
		Implements (at least 4)
			*PeerAddress : github.com/pion/stun/v3.Getter
			 PeerAddress : github.com/pion/stun/v3.Setter
			 PeerAddress : expvar.Var
			 PeerAddress : fmt.Stringer

	 type Protocol byte (basic type)
		Protocol is IANA assigned protocol number.

		Methods (only one)
			( Protocol) String() string
		Implements (at least 2)
			 Protocol : expvar.Var
			 Protocol : fmt.Stringer
		As Types Of (total 2)
			const ProtoTCP
			const ProtoUDP

	 type RelayedAddress (struct)
		RelayedAddress implements XOR-RELAYED-ADDRESS attribute.
		
		It specifies the address and port that the server allocated to the
		client. It is encoded in the same way as XOR-MAPPED-ADDRESS.
		
		RFC 5766 Section 14.5.

		Fields (total 2)
			IP net.IP
			Port int
		Methods (total 3)
			( RelayedAddress) AddTo(m *stun.Message) error
				AddTo adds XOR-PEER-ADDRESS to message.

			(*RelayedAddress) GetFrom(m *stun.Message) error
				GetFrom decodes XOR-PEER-ADDRESS from message.

			( RelayedAddress) String() string
		Implements (at least 4)
			*RelayedAddress : github.com/pion/stun/v3.Getter
			 RelayedAddress : github.com/pion/stun/v3.Setter
			 RelayedAddress : expvar.Var
			 RelayedAddress : fmt.Stringer

	 type RequestedAddressFamily byte (basic type)
		RequestedAddressFamily represents the REQUESTED-ADDRESS-FAMILY Attribute as
		defined in RFC 6156 Section 4.1.1.

		Methods (total 3)
			( RequestedAddressFamily) AddTo(m *stun.Message) error
				AddTo adds REQUESTED-ADDRESS-FAMILY to message.

			(*RequestedAddressFamily) GetFrom(m *stun.Message) error
				GetFrom decodes REQUESTED-ADDRESS-FAMILY from message.

			( RequestedAddressFamily) String() string
		Implements (at least 4)
			*RequestedAddressFamily : github.com/pion/stun/v3.Getter
			 RequestedAddressFamily : github.com/pion/stun/v3.Setter
			 RequestedAddressFamily : expvar.Var
			 RequestedAddressFamily : fmt.Stringer
		As Types Of (total 2)
			const RequestedFamilyIPv4
			const RequestedFamilyIPv6

	 type RequestedTransport (struct)
		RequestedTransport represents REQUESTED-TRANSPORT attribute.
		
		This attribute is used by the client to request a specific transport
		protocol for the allocated transport address. RFC 5766 only allows the use of
		code point 17 (User Datagram Protocol).
		
		RFC 5766 Section 14.7.

		Fields (only one)
			Protocol Protocol
		Methods (total 3)
			( RequestedTransport) AddTo(m *stun.Message) error
				AddTo adds REQUESTED-TRANSPORT to message.

			(*RequestedTransport) GetFrom(m *stun.Message) error
				GetFrom decodes REQUESTED-TRANSPORT from message.

			( RequestedTransport) String() string
		Implements (at least 4)
			*RequestedTransport : github.com/pion/stun/v3.Getter
			 RequestedTransport : github.com/pion/stun/v3.Setter
			 RequestedTransport : expvar.Var
			 RequestedTransport : fmt.Stringer

	 type ReservationToken ([])
		ReservationToken represents RESERVATION-TOKEN attribute.
		
		The RESERVATION-TOKEN attribute contains a token that uniquely
		identifies a relayed transport address being held in reserve by the
		server. The server includes this attribute in a success response to
		tell the client about the token, and the client includes this
		attribute in a subsequent Allocate request to request the server use
		that relayed transport address for the allocation.
		
		RFC 5766 Section 14.9.

		Methods (total 2)
			( ReservationToken) AddTo(m *stun.Message) error
				AddTo adds RESERVATION-TOKEN to message.

			(*ReservationToken) GetFrom(m *stun.Message) error
				GetFrom decodes RESERVATION-TOKEN from message.

		Implements (at least 2)
			*ReservationToken : github.com/pion/stun/v3.Getter
			 ReservationToken : github.com/pion/stun/v3.Setter

	 type XORPeerAddress = PeerAddress (struct)
		XORPeerAddress implements XOR-PEER-ADDRESS attribute.
		
		The XOR-PEER-ADDRESS specifies the address and port of the peer as
		seen from the TURN server. (For example, the peer's server-reflexive
		transport address if the peer is behind a NAT.)
		
		RFC 5766 Section 14.3.

	 type XORRelayedAddress = RelayedAddress (struct)
		XORRelayedAddress implements XOR-RELAYED-ADDRESS attribute.
		
		It specifies the address and port that the server allocated to the
		client. It is encoded in the same way as XOR-MAPPED-ADDRESS.
		
		RFC 5766 Section 14.5.


Package-Level Functions (total 5)

	 func AllocateRequest() stun.MessageType
		AllocateRequest is shorthand for allocation request message type.

	 func CreatePermissionRequest() stun.MessageType
		CreatePermissionRequest is shorthand for create permission request type.

	 func IsChannelData(buf []byte) bool
		IsChannelData returns true if buf looks like the ChannelData Message.

	 func RefreshRequest() stun.MessageType
		RefreshRequest is shorthand for refresh request message type.

	 func SendIndication() stun.MessageType
		SendIndication is shorthand for send indication message type.


Package-Level Variables (total 2)

	  var ErrBadChannelDataLength error
		ErrBadChannelDataLength means that channel data length is not equal
		to actual data length.

	  var ErrInvalidChannelNumber error
		ErrInvalidChannelNumber means that channel number is not valid as by RFC 5766 Section 11.


Package-Level Constants (total 9)

	const DefaultLifetime time.Duration = 600000000000
		DefaultLifetime in RFC 5766 is 10 minutes.
		
		RFC 5766 Section 2.2.

	const DefaultPort = 3478
		DefaultPort for TURN is same as STUN.

	const DefaultTLSPort = 5349
		DefaultTLSPort is for TURN over TLS and is same as STUN.

	const MaxChannelNumber = 32767
		See https://tools.ietf.org/html/rfc5766#section-11:
		
		0x4000 through 0x7FFF: These values are the allowed channel
		numbers (16,383 possible values).

	const MinChannelNumber = 16384
		See https://tools.ietf.org/html/rfc5766#section-11:
		
		0x4000 through 0x7FFF: These values are the allowed channel
		numbers (16,383 possible values).

	const ProtoTCP Protocol = 6
		ProtoTCP is IANA assigned protocol number for TCP.

	const ProtoUDP Protocol = 17
		ProtoUDP is IANA assigned protocol number for UDP.

	const RequestedFamilyIPv4 RequestedAddressFamily = 1
		Values for RequestedAddressFamily as defined in RFC 6156 Section 4.1.1.

	const RequestedFamilyIPv6 RequestedAddressFamily = 2
		Values for RequestedAddressFamily as defined in RFC 6156 Section 4.1.1.

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.