package turn

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

Dependency Relation
	imports 22 packages, and imported by one package

Involved Source Files

	    client.go
	    errors.go
	    lt_cred.go
	    relay_address_generator_none.go
	    relay_address_generator_range.go
	    relay_address_generator_static.go
	  d server.go
		Package turn contains the public API for pion/turn, a toolkit for building TURN clients and servers

	    server_config.go
	    stun_conn.go
Package-Level Type Names (total 13)

	/* sort by: alphabet | popularity */
	 type AuthHandler (func)
		AuthHandler is a callback used to handle incoming auth requests,
		allowing users to customize Pion TURN with custom behavior.

		As Outputs Of (at least 2)
			func LongTermTURNRESTAuthHandler(sharedSecret string, logger logging.LeveledLogger) AuthHandler
			func NewLongTermAuthHandler(sharedSecret string, logger logging.LeveledLogger) AuthHandler

	 type Client (struct)
		Client is a STUN server client.

		Methods (total 15)
			(*Client) Allocate() (net.PacketConn, error)
				Allocate sends a TURN allocation request to the given transport address.

			(*Client) AllocateTCP() (*client.TCPAllocation, error)
				AllocateTCP creates a new TCP allocation at the TURN server.

			(*Client) Close()
				Close closes this client.

			(*Client) CreatePermission(addrs ...net.Addr) error
				CreatePermission Issues a CreatePermission request for the supplied addresses
				as described in https://datatracker.ietf.org/doc/html/rfc5766#section-9

			(*Client) HandleInbound(data []byte, from net.Addr) (bool, error)
				HandleInbound handles data received.
				This method handles incoming packet de-multiplex it by the source address
				and the types of the message.
				This return a boolean (handled or not) and if there was an error.
				Caller should check if the packet was handled by this client or not.
				If not handled, it is assumed that the packet is application data.
				If an error is returned, the caller should discard the packet regardless.

			(*Client) Listen() error
				Listen will have this client start listening on the conn provided via the config.
				This is optional. If not used, you will need to call HandleInbound method
				to supply incoming data, instead.

			(*Client) OnDeallocated(net.Addr)
				OnDeallocated is called when de-allocation of relay address has been complete.
				(Called by UDPConn).

			(*Client) PerformTransaction(msg *stun.Message, to net.Addr, ignoreResult bool) (client.TransactionResult, error)
				PerformTransaction performs STUN transaction.

			(*Client) Realm() stun.Realm
				Realm return realm.

			(*Client) STUNServerAddr() net.Addr
				STUNServerAddr return the STUN server address.

			(*Client) SendBindingRequest() (net.Addr, error)
				SendBindingRequest sends a new STUN request to the STUN server.

			(*Client) SendBindingRequestTo(to net.Addr) (net.Addr, error)
				SendBindingRequestTo sends a new STUN request to the given transport address.

			(*Client) TURNServerAddr() net.Addr
				TURNServerAddr return the TURN server address.

			(*Client) Username() stun.Username
				Username returns username.

			(*Client) WriteTo(data []byte, to net.Addr) (int, error)
				WriteTo sends data to the specified destination using the base socket.

		Implements (at least one exported)
			*Client : github.com/pion/turn/v4/internal/client.Client
		As Outputs Of (at least one exported)
			func NewClient(config *ClientConfig) (*Client, error)

	 type ClientConfig (struct)
		ClientConfig is a bag of config parameters for Client.

		Fields (total 10)
			Conn net.PacketConn
				// Listening socket (net.PacketConn)

			LoggerFactory logging.LoggerFactory
			Net transport.Net
			Password string
			RTO time.Duration
			Realm string
			STUNServerAddr string
				// STUN server address (e.g. "stun.abc.com:3478")

			Software string
			TURNServerAddr string
				// TURN server address (e.g. "turn.abc.com:3478")

			Username string
		As Inputs Of (at least one exported)
			func NewClient(config *ClientConfig) (*Client, error)

	 type ListenerConfig (struct)
		ListenerConfig is a single net.Listener to accept connections on.
		This will be used for TCP, TLS and DTLS listeners.

		Fields (total 3)
			Listener net.Listener
			PermissionHandler PermissionHandler
				PermissionHandler is a callback to filter peer addresses. Can be set as nil, in which
				case the DefaultPermissionHandler is automatically instantiated to admit all peer
				connections

			RelayAddressGenerator RelayAddressGenerator
				When an allocation is generated the RelayAddressGenerator
				creates the net.PacketConn and returns the IP/Port it is available at


	 type PacketConnConfig (struct)
		PacketConnConfig is a single net.PacketConn to listen/write on.
		This will be used for UDP listeners.

		Fields (total 3)
			PacketConn net.PacketConn
			PermissionHandler PermissionHandler
				PermissionHandler is a callback to filter peer addresses. Can be set as nil, in which
				case the DefaultPermissionHandler is automatically instantiated to admit all peer
				connections

			RelayAddressGenerator RelayAddressGenerator
				When an allocation is generated the RelayAddressGenerator
				creates the net.PacketConn and returns the IP/Port it is available at


	 type PermissionHandler (func)
		PermissionHandler is a callback to filter incoming CreatePermission and ChannelBindRequest
		requests based on the client IP address and port and the peer IP address the client intends to
		connect to. If the client is behind a NAT then the filter acts on the server reflexive
		("mapped") address instead of the real client IP address and port. Note that TURN permissions
		are per-allocation and per-peer-IP-address, to mimic the address-restricted filtering mechanism
		of NATs that comply with [RFC4787], see https://tools.ietf.org/html/rfc5766#section-2.3.

	 type RelayAddressGenerator (interface)
		RelayAddressGenerator is used to generate a RelayAddress when creating an allocation.
		You can use one of the provided ones or provide your own.

		Methods (total 3)
			( RelayAddressGenerator) AllocateConn(network string, requestedPort int) (net.Conn, net.Addr, error)
				Allocate a Conn (TCP) RelayAddress

			( RelayAddressGenerator) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)
				Allocate a PacketConn (UDP) RelayAddress

			( RelayAddressGenerator) Validate() error
				Validate confirms that the RelayAddressGenerator is properly initialized

		Implemented By (at least 3)
			*RelayAddressGeneratorNone
			*RelayAddressGeneratorPortRange
			*RelayAddressGeneratorStatic

	 type RelayAddressGeneratorNone (struct)
		RelayAddressGeneratorNone returns the listener with no modifications.

		Fields (total 2)
			Address string
				Address is passed to Listen/ListenPacket when creating the Relay

			Net transport.Net
		Methods (total 3)
			(*RelayAddressGeneratorNone) AllocateConn(string, int) (net.Conn, net.Addr, error)
				AllocateConn generates a new Conn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorNone) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)
				AllocatePacketConn generates a new PacketConn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorNone) Validate() error
				Validate is called on server startup and confirms the RelayAddressGenerator is properly configured.

		Implements (at least one exported)
			*RelayAddressGeneratorNone : RelayAddressGenerator

	 type RelayAddressGeneratorPortRange (struct)
		RelayAddressGeneratorPortRange can be used to only allocate connections inside a defined port range.
		Similar to the RelayAddressGeneratorStatic a static ip address can be set.

		Fields (total 7)
			Address string
				Address is passed to Listen/ListenPacket when creating the Relay

			MaxPort uint16
				MaxPort the maximum (inclusive) port to allocate

			MaxRetries int
				MaxRetries the amount of tries to allocate a random port in the defined range

			MinPort uint16
				MinPort the minimum port to allocate

			Net transport.Net
			Rand randutil.MathRandomGenerator
				Rand the random source of numbers

			RelayAddress net.IP
				RelayAddress is the IP returned to the user when the relay is created

		Methods (total 3)
			(*RelayAddressGeneratorPortRange) AllocateConn(string, int) (net.Conn, net.Addr, error)
				AllocateConn generates a new Conn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorPortRange) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)
				AllocatePacketConn generates a new PacketConn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorPortRange) Validate() error
				Validate is called on server startup and confirms the RelayAddressGenerator is properly configured.

		Implements (at least one exported)
			*RelayAddressGeneratorPortRange : RelayAddressGenerator

	 type RelayAddressGeneratorStatic (struct)
		RelayAddressGeneratorStatic can be used to return static IP address each time a relay is created.
		This can be used when you have a single static IP address that you want to use.

		Fields (total 3)
			Address string
				Address is passed to Listen/ListenPacket when creating the Relay

			Net transport.Net
			RelayAddress net.IP
				RelayAddress is the IP returned to the user when the relay is created

		Methods (total 3)
			(*RelayAddressGeneratorStatic) AllocateConn(string, int) (net.Conn, net.Addr, error)
				AllocateConn generates a new Conn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorStatic) AllocatePacketConn(network string, requestedPort int) (net.PacketConn, net.Addr, error)
				AllocatePacketConn generates a new PacketConn to receive traffic on and the IP/Port
				to populate the allocation response with.

			(*RelayAddressGeneratorStatic) Validate() error
				Validate is called on server startup and confirms the RelayAddressGenerator is properly configured.

		Implements (at least one exported)
			*RelayAddressGeneratorStatic : RelayAddressGenerator

	 type Server (struct)
		Server is an instance of the Pion TURN Server.

		Methods (total 2)
			(*Server) AllocationCount() int
				AllocationCount returns the number of active allocations.
				It can be used to drain the server before closing.

			(*Server) Close() error
				Close stops the TURN Server.
				It cleans up any associated state and closes all connections it is managing.

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

	 type ServerConfig (struct)
		ServerConfig configures the Pion TURN Server.

		Fields (total 7)
			AuthHandler AuthHandler
				AuthHandler is a callback used to handle incoming auth requests,
				allowing users to customize Pion TURN with custom behavior

			ChannelBindTimeout time.Duration
				ChannelBindTimeout sets the lifetime of channel binding. Defaults to 10 minutes.

			InboundMTU int
				Sets the server inbound MTU(Maximum transmition unit). Defaults to 1600 bytes.

			ListenerConfigs []ListenerConfig
			LoggerFactory logging.LoggerFactory
				LoggerFactory must be set for logging from this server.

			PacketConnConfigs []PacketConnConfig
				PacketConnConfigs and ListenerConfigs are a list of all the turn listeners
				Each listener can have custom behavior around the creation of Relays

			Realm string
				Realm sets the realm for this server

		As Inputs Of (at least one exported)
			func NewServer(config ServerConfig) (*Server, error)

	 type STUNConn (struct)
		STUNConn wraps a net.Conn and implements
		net.PacketConn by being STUN aware and
		packetizing the stream.

		Methods (total 7)
			(*STUNConn) Close() error
				Close implements Close from net.PacketConn.

			(*STUNConn) LocalAddr() net.Addr
				LocalAddr implements LocalAddr from net.PacketConn.

			(*STUNConn) ReadFrom(payload []byte) (n int, addr net.Addr, err error)
				ReadFrom implements ReadFrom from net.PacketConn.

			(*STUNConn) SetDeadline(t time.Time) error
				SetDeadline implements SetDeadline from net.PacketConn.

			(*STUNConn) SetReadDeadline(t time.Time) error
				SetReadDeadline implements SetReadDeadline from net.PacketConn.

			(*STUNConn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline implements SetWriteDeadline from net.PacketConn.

			(*STUNConn) WriteTo(payload []byte, _ net.Addr) (n int, err error)
				WriteTo implements WriteTo from net.PacketConn.

		Implements (at least 5)
			*STUNConn : github.com/pion/datachannel.ReadDeadliner
			*STUNConn : github.com/pion/datachannel.WriteDeadliner
			*STUNConn : github.com/prometheus/common/expfmt.Closer
			*STUNConn : io.Closer
			*STUNConn : net.PacketConn
		As Outputs Of (at least one exported)
			func NewSTUNConn(nextConn net.Conn) *STUNConn


Package-Level Functions (total 9)

	 func DefaultPermissionHandler(net.Addr, net.IP) (ok bool)
		DefaultPermissionHandler is convince function that grants permission to all peers.

	 func GenerateAuthKey(username, realm, password string) []byte
		GenerateAuthKey is a convenience function to easily generate keys in the format used by AuthHandler.

	 func GenerateLongTermCredentials(sharedSecret string, duration time.Duration) (string, string, error)
		GenerateLongTermCredentials can be used to create credentials valid for [duration] time.

	 func GenerateLongTermTURNRESTCredentials(sharedSecret string, user string, duration time.Duration) (string, string, error)
		GenerateLongTermTURNRESTCredentials can be used to create credentials valid for [duration] time.

	 func LongTermTURNRESTAuthHandler(sharedSecret string, logger logging.LeveledLogger) AuthHandler
		LongTermTURNRESTAuthHandler returns a turn.AuthAuthHandler that can be used to authenticate
		time-windowed ephemeral credentials generated by the TURN REST API as described in
		https://datatracker.ietf.org/doc/html/draft-uberti-behave-turn-rest-00
		
		The supported format of is timestamp:username, where username is an arbitrary user id and the
		timestamp specifies the expiry of the credential.

	 func NewClient(config *ClientConfig) (*Client, error)
		NewClient returns a new Client instance. listeningAddress is the address and port to listen on,
		default "0.0.0.0:0".

	 func NewLongTermAuthHandler(sharedSecret string, logger logging.LeveledLogger) AuthHandler
		NewLongTermAuthHandler returns a turn.AuthAuthHandler used with Long Term (or Time Windowed) Credentials.
		See: https://datatracker.ietf.org/doc/html/rfc8489#section-9.2
		.

	 func NewServer(config ServerConfig) (*Server, error)
		NewServer creates the Pion TURN server.

	 func NewSTUNConn(nextConn net.Conn) *STUNConn
		NewSTUNConn creates a STUNConn.

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.