package mux

Import Path
	github.com/pion/webrtc/v4/internal/mux (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    endpoint.go
	  d mux.go
		Package mux multiplexes packets on a single socket (RFC7983)

	    muxfunc.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config collects the arguments to mux.Mux construction into
		a single structure.

		Fields (total 3)
			BufferSize int
			Conn net.Conn
			LoggerFactory logging.LoggerFactory
		As Inputs Of (at least one exported)
			func NewMux(config Config) *Mux

	 type Endpoint (struct)
		Endpoint implements net.Conn. It is used to read muxed packets.

		Methods (total 11)
			(*Endpoint) Close() (err error)
				Close unregisters the endpoint from the Mux.

			(*Endpoint) LocalAddr() net.Addr
				LocalAddr is a stub.

			(*Endpoint) Read(p []byte) (int, error)
				Read reads a packet of len(p) bytes from the underlying conn
				that are matched by the associated MuxFunc.

			(*Endpoint) ReadFrom(p []byte) (int, net.Addr, error)
				ReadFrom reads a packet of len(p) bytes from the underlying conn
				that are matched by the associated MuxFunc.

			(*Endpoint) RemoteAddr() net.Addr
				RemoteAddr is a stub.

			(*Endpoint) SetDeadline(time.Time) error
				SetDeadline is a stub.

			(*Endpoint) SetOnClose(onClose func())
				SetOnClose is a user set callback that
				will be executed when `Close` is called.

			(*Endpoint) SetReadDeadline(time.Time) error
				SetReadDeadline is a stub.

			(*Endpoint) SetWriteDeadline(time.Time) error
				SetWriteDeadline is a stub.

			(*Endpoint) Write(p []byte) (int, error)
				Write writes len(p) bytes to the underlying conn.

			(*Endpoint) WriteTo(p []byte, _ net.Addr) (int, error)
				WriteTo writes len(p) bytes to the underlying conn.

		Implements (at least 16)
			*Endpoint : github.com/pion/datachannel.ReadDeadliner
			*Endpoint : github.com/pion/datachannel.WriteDeadliner
			*Endpoint : github.com/pion/stun.Connection
			*Endpoint : github.com/pion/stun/v3.Connection
			*Endpoint : github.com/miekg/dns.Writer
			*Endpoint : github.com/prometheus/common/expfmt.Closer
			*Endpoint : internal/bisect.Writer
			*Endpoint : io.Closer
			*Endpoint : io.ReadCloser
			*Endpoint : io.Reader
			*Endpoint : io.ReadWriteCloser
			*Endpoint : io.ReadWriter
			*Endpoint : io.WriteCloser
			*Endpoint : io.Writer
			*Endpoint : net.Conn
			*Endpoint : net.PacketConn
		As Outputs Of (at least one exported)
			func (*Mux).NewEndpoint(matchFunc MatchFunc) *Endpoint
		As Inputs Of (at least one exported)
			func (*Mux).RemoveEndpoint(e *Endpoint)

	 type MatchFunc (func)
		MatchFunc allows custom logic for mapping packets to an Endpoint.

		As Inputs Of (at least one exported)
			func (*Mux).NewEndpoint(matchFunc MatchFunc) *Endpoint

	 type Mux (struct)
		Mux allows multiplexing.

		Methods (total 3)
			(*Mux) Close() error
				Close closes the Mux and all associated Endpoints.

			(*Mux) NewEndpoint(matchFunc MatchFunc) *Endpoint
				NewEndpoint creates a new Endpoint.

			(*Mux) RemoveEndpoint(e *Endpoint)
				RemoveEndpoint removes an endpoint from the Mux.

		Implements (at least 2)
			*Mux : github.com/prometheus/common/expfmt.Closer
			*Mux : io.Closer
		As Outputs Of (at least one exported)
			func NewMux(config Config) *Mux


Package-Level Functions (total 7)

	 func MatchAll([]byte) bool
		MatchAll always returns true.

	 func MatchDTLS(b []byte) bool
		MatchDTLS is a MatchFunc that accepts packets with the first byte in [20..63]
		as defied in RFC7983.

	 func MatchRange(lower, upper byte, buf []byte) bool
		MatchRange returns true if the first byte of buf is in [lower..upper].

	 func MatchSRTCP(buf []byte) bool
		MatchSRTCP is a MatchFunc that only matches SRTCP and not SRTP.

	 func MatchSRTP(buf []byte) bool
		MatchSRTP is a MatchFunc that only matches SRTP and not SRTCP.

	 func MatchSRTPOrSRTCP(b []byte) bool
		MatchSRTPOrSRTCP is a MatchFunc that accepts packets with the first byte in [128..191]
		as defied in RFC7983.

	 func NewMux(config Config) *Mux
		NewMux creates a new Mux.

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.