package udp

Import Path
	github.com/pion/dtls/v3/internal/net/udp (on go.dev)

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	  d packet_conn.go
		Package udp implements DTLS specific UDP networking primitives.
		NOTE: this package is an adaption of pion/transport/udp that allows for
		routing datagrams based on identifiers other than the remote address. The
		primary use case for this functionality is routing based on DTLS connection
		IDs. In order to allow for consumers of this package to treat connections as
		generic net.PackageConn, routing and identitier establishment is based on
		custom introspecion of datagrams, rather than direct intervention by
		consumers. If possible, the updates made in this repository will be reflected
		back upstream. If not, it is likely that this will be moved to a public
		package in this repository.
		
		This package was migrated from pion/transport/udp at
		https://github.com/pion/transport/commit/6890c795c807a617c054149eee40a69d7fdfbfdb
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ListenConfig (struct)
		ListenConfig stores options for listening to an address.

		Fields (total 4)
			AcceptFilter func([]byte) bool
				AcceptFilter determines whether the new conn should be made for
				the incoming packet. If not set, any packet creates new conn.

			Backlog int
				Backlog defines the maximum length of the queue of pending
				connections. It is equivalent of the backlog argument of
				POSIX listen function.
				If a connection request arrives when the queue is full,
				the request will be silently discarded, unlike TCP.
				Set zero to use default value 128 which is same as Linux default.

			ConnectionIdentifier func([]byte) (string, bool)
				ConnectionIdentifier extracts an identifier from an outgoing packet. If
				the identifier is not already associated with the connection, it will be
				added.

			DatagramRouter func([]byte) (string, bool)
				DatagramRouter routes an incoming datagram to a connection by extracting
				an identifier from the its paylod

		Methods (only one)
			(*ListenConfig) Listen(network string, laddr *net.UDPAddr) (dtlsnet.PacketListener, error)
				Listen creates a new listener based on the ListenConfig.


	 type PacketConn (struct)
		PacketConn is a net.PacketConn implementation that is able to dictate its
		routing ID via an alternate identifier from its remote address. Internal
		buffering is performed for reads, and writes are passed through to the
		underlying net.PacketConn.

		Methods (total 7)
			(*PacketConn) Close() error
				Close closes the conn and releases any Read calls.

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

			(*PacketConn) ReadFrom(buff []byte) (int, net.Addr, error)
				ReadFrom reads a single packet payload and its associated remote address from
				the underlying buffer.

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

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

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

			(*PacketConn) WriteTo(payload []byte, addr net.Addr) (n int, err error)
				WriteTo writes len(payload) bytes from payload to the specified address.

		Implements (at least 5)
			*PacketConn : github.com/pion/datachannel.ReadDeadliner
			*PacketConn : github.com/pion/datachannel.WriteDeadliner
			*PacketConn : github.com/prometheus/common/expfmt.Closer
			*PacketConn : io.Closer
			*PacketConn : net.PacketConn


Package-Level Functions (only one)

	 func Listen(network string, laddr *net.UDPAddr) (dtlsnet.PacketListener, error)
		Listen creates a new listener using default ListenConfig.


Package-Level Variables (total 2)

	  var ErrClosedListener error
		Typed errors.

	  var ErrListenQueueExceeded error
		Typed errors.

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.