package net

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

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	  d buffer.go
		Package net implements DTLS specific networking primitives.
		NOTE: this package is an adaption of pion/transport/packetio that allows for
		storing a remote address alongside each packet in the buffer and implements
		relevant methods of net.PacketConn. 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/packetio at
		https://github.com/pion/transport/commit/6890c795c807a617c054149eee40a69d7fdfbfdb
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type AddrPacket (struct)
		AddrPacket is a packet payload and the associated remote address from which
		it was received.

	 type PacketBuffer (struct)
		PacketBuffer is a circular buffer for network packets. Each slot in the
		buffer contains the remote address from which the packet was received, as
		well as the packet data.

		Methods (total 4)
			(*PacketBuffer) Close() (err error)
				Close closes the buffer, allowing unread packets to be read, but erroring on
				any new writes.

			(*PacketBuffer) ReadFrom(packet []byte) (n int, addr net.Addr, err error)
				ReadFrom reads a single packet from the buffer, or blocks until one is
				available.

			(*PacketBuffer) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the read deadline for the buffer.

			(*PacketBuffer) WriteTo(pkt []byte, addr net.Addr) (int, error)
				WriteTo writes a single packet to the buffer. The supplied address will
				remain associated with the packet.

		Implements (at least 3)
			*PacketBuffer : github.com/pion/datachannel.ReadDeadliner
			*PacketBuffer : github.com/prometheus/common/expfmt.Closer
			*PacketBuffer : io.Closer
		As Outputs Of (at least one exported)
			func NewPacketBuffer() *PacketBuffer


Package-Level Functions (only one)

	 func NewPacketBuffer() *PacketBuffer
		NewPacketBuffer creates a new PacketBuffer.


Package-Level Variables (only one)

	  var ErrTimeout error
		ErrTimeout indicates that deadline was reached before operation could be
		completed.

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.