package allocation

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

Dependency Relation
	imports 10 packages, and imported by 2 packages

Involved Source Files

	  d allocation.go
		Package allocation contains all CRUD operations for allocations

	    allocation_manager.go
	    channel_bind.go
	    errors.go
	    five_tuple.go
	    permission.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Allocation (struct)
		Allocation is tied to a FiveTuple and relays traffic
		use CreateAllocation and GetAllocation to operate.

		Fields (total 4)
			Protocol Protocol
			RelayAddr net.Addr
			RelaySocket net.PacketConn
			TurnSocket net.PacketConn
		Methods (total 11)
			(*Allocation) AddChannelBind(chanBind *ChannelBind, lifetime time.Duration) error
				AddChannelBind adds a new ChannelBind to the allocation, it also updates the
				permissions needed for this ChannelBind.

			(*Allocation) AddPermission(perms *Permission)
				AddPermission adds a new permission to the allocation.

			(*Allocation) Close() error
				Close closes the allocation.

			(*Allocation) GetChannelByAddr(addr net.Addr) *ChannelBind
				GetChannelByAddr gets the ChannelBind from this allocation by net.Addr.

			(*Allocation) GetChannelByNumber(number proto.ChannelNumber) *ChannelBind
				GetChannelByNumber gets the ChannelBind from this allocation by id.

			(*Allocation) GetPermission(addr net.Addr) *Permission
				GetPermission gets the Permission from the allocation.

			(*Allocation) GetResponseCache() (id [12]byte, attrs []stun.Setter)
				GetResponseCache return response cache for retransmit allocation request.

			(*Allocation) Refresh(lifetime time.Duration)
				Refresh updates the allocations lifetime.

			(*Allocation) RemoveChannelBind(number proto.ChannelNumber) bool
				RemoveChannelBind removes the ChannelBind from this allocation by id.

			(*Allocation) RemovePermission(addr net.Addr)
				RemovePermission removes the net.Addr's fingerprint from the allocation's permissions.

			(*Allocation) SetResponseCache(transactionID [12]byte, attrs []stun.Setter)
				SetResponseCache cache allocation response for retransmit allocation request.

		Implements (at least 2)
			*Allocation : github.com/prometheus/common/expfmt.Closer
			*Allocation : io.Closer
		As Outputs Of (at least 3)
			func NewAllocation(turnSocket net.PacketConn, fiveTuple *FiveTuple, log logging.LeveledLogger) *Allocation
			func (*Manager).CreateAllocation(fiveTuple *FiveTuple, turnSocket net.PacketConn, requestedPort int, lifetime time.Duration) (*Allocation, error)
			func (*Manager).GetAllocation(fiveTuple *FiveTuple) *Allocation

	 type ChannelBind (struct)
		ChannelBind represents a TURN Channel
		See: https://tools.ietf.org/html/rfc5766#section-2.5

		Fields (total 2)
			Number proto.ChannelNumber
			Peer net.Addr
		As Outputs Of (at least 3)
			func NewChannelBind(number proto.ChannelNumber, peer net.Addr, log logging.LeveledLogger) *ChannelBind
			func (*Allocation).GetChannelByAddr(addr net.Addr) *ChannelBind
			func (*Allocation).GetChannelByNumber(number proto.ChannelNumber) *ChannelBind
		As Inputs Of (at least one exported)
			func (*Allocation).AddChannelBind(chanBind *ChannelBind, lifetime time.Duration) error

	 type FiveTuple (struct)
		FiveTuple is the combination (client IP address and port, server IP
		address and port, and transport protocol (currently one of UDP,
		TCP, or TLS)) used to communicate between the client and the
		server.  The 5-tuple uniquely identifies this communication
		stream.  The 5-tuple also uniquely identifies the Allocation on
		the server.

		Fields (total 3)
			DstAddr net.Addr
			Protocol Protocol
			SrcAddr net.Addr
		Methods (total 2)
			(*FiveTuple) Equal(b *FiveTuple) bool
				Equal asserts if two FiveTuples are equal.

			(*FiveTuple) Fingerprint() (fp FiveTupleFingerprint)
				Fingerprint is the identity of a FiveTuple.

		As Inputs Of (at least 5)
			func NewAllocation(turnSocket net.PacketConn, fiveTuple *FiveTuple, log logging.LeveledLogger) *Allocation
			func (*FiveTuple).Equal(b *FiveTuple) bool
			func (*Manager).CreateAllocation(fiveTuple *FiveTuple, turnSocket net.PacketConn, requestedPort int, lifetime time.Duration) (*Allocation, error)
			func (*Manager).DeleteAllocation(fiveTuple *FiveTuple)
			func (*Manager).GetAllocation(fiveTuple *FiveTuple) *Allocation

	 type FiveTupleFingerprint (struct)
		FiveTupleFingerprint is a comparable representation of a FiveTuple.

		As Outputs Of (at least one exported)
			func (*FiveTuple).Fingerprint() (fp FiveTupleFingerprint)

	 type Manager (struct)
		Manager is used to hold active allocations.

		Methods (total 9)
			(*Manager) AllocationCount() int
				AllocationCount returns the number of existing allocations.

			(*Manager) Close() error
				Close closes the manager and closes all allocations it manages.

			(*Manager) CreateAllocation(fiveTuple *FiveTuple, turnSocket net.PacketConn, requestedPort int, lifetime time.Duration) (*Allocation, error)
				CreateAllocation creates a new allocation and starts relaying.

			(*Manager) CreateReservation(reservationToken string, port int)
				CreateReservation stores the reservation for the token+port.

			(*Manager) DeleteAllocation(fiveTuple *FiveTuple)
				DeleteAllocation removes an allocation.

			(*Manager) GetAllocation(fiveTuple *FiveTuple) *Allocation
				GetAllocation fetches the allocation matching the passed FiveTuple.

			(*Manager) GetRandomEvenPort() (int, error)
				GetRandomEvenPort returns a random un-allocated udp4 port.

			(*Manager) GetReservation(reservationToken string) (int, bool)
				GetReservation returns the port for a given reservation if it exists.

			(*Manager) GrantPermission(sourceAddr net.Addr, peerIP net.IP) error
				GrantPermission handles permission requests by calling the permission handler callback
				associated with the TURN server listener socket.

		Implements (at least 2)
			*Manager : github.com/prometheus/common/expfmt.Closer
			*Manager : io.Closer
		As Outputs Of (at least one exported)
			func NewManager(config ManagerConfig) (*Manager, error)

	 type ManagerConfig (struct)
		ManagerConfig a bag of config params for Manager.

		Fields (total 4)
			AllocateConn func(network string, requestedPort int) (net.Conn, net.Addr, error)
			AllocatePacketConn func(network string, requestedPort int) (net.PacketConn, net.Addr, error)
			LeveledLogger logging.LeveledLogger
			PermissionHandler func(sourceAddr net.Addr, peerIP net.IP) bool
		As Inputs Of (at least one exported)
			func NewManager(config ManagerConfig) (*Manager, error)

	 type Permission (struct)
		Permission represents a TURN permission. TURN permissions mimic the address-restricted
		filtering mechanism of NATs that comply with [RFC4787].
		See: https://tools.ietf.org/html/rfc5766#section-2.3

		Fields (only one)
			Addr net.Addr
		As Outputs Of (at least 2)
			func NewPermission(addr net.Addr, log logging.LeveledLogger) *Permission
			func (*Allocation).GetPermission(addr net.Addr) *Permission
		As Inputs Of (at least one exported)
			func (*Allocation).AddPermission(perms *Permission)

	 type Protocol uint8 (basic type)
		Protocol is an enum for relay protocol.

		As Types Of (total 2)
			const TCP
			const UDP


Package-Level Functions (total 4)

	 func NewAllocation(turnSocket net.PacketConn, fiveTuple *FiveTuple, log logging.LeveledLogger) *Allocation
		NewAllocation creates a new instance of NewAllocation.

	 func NewChannelBind(number proto.ChannelNumber, peer net.Addr, log logging.LeveledLogger) *ChannelBind
		NewChannelBind creates a new ChannelBind.

	 func NewManager(config ManagerConfig) (*Manager, error)
		NewManager creates a new instance of Manager.

	 func NewPermission(addr net.Addr, log logging.LeveledLogger) *Permission
		NewPermission create a new Permission.


Package-Level Constants (total 2)

	const TCP Protocol = 1
		Network protocols for relay.

	const UDP Protocol = 0
		Network protocols for relay.

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.