package netctx

Import Path
	github.com/pion/transport/v3/netctx (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	  d conn.go
		Package netctx wraps common net interfaces using context.Context.

	    packetconn.go
	    pipe.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Conn (interface)
		Conn is a wrapper of net.Conn using context.Context.

		Methods (total 6)
			( Conn) Close() error
			( Conn) Conn() net.Conn
			( Conn) LocalAddr() net.Addr
			( Conn) ReadContext(context.Context, []byte) (int, error)
			( Conn) RemoteAddr() net.Addr
			( Conn) WriteContext(context.Context, []byte) (int, error)
		Implemented By (at least one exported)
			 github.com/pion/transport/v2/connctx.ConnCtx (interface)
		Implements (at least 9)
			 Conn : Reader
			 Conn : ReadWriter
			 Conn : Writer
			 Conn : github.com/pion/transport/v2/connctx.ConnCtx
			 Conn : github.com/pion/transport/v2/connctx.Reader
			 Conn : github.com/pion/transport/v2/connctx.ReadWriter
			 Conn : github.com/pion/transport/v2/connctx.Writer
			 Conn : github.com/prometheus/common/expfmt.Closer
			 Conn : io.Closer
		As Outputs Of (at least 3)
			func NewConn(netConn net.Conn) Conn
			func Pipe() (Conn, Conn)
			func Pipe() (Conn, Conn)

	 type PacketConn (interface)
		PacketConn is a wrapper of net.PacketConn using context.Context.

		Methods (total 5)
			( PacketConn) Close() error
			( PacketConn) Conn() net.PacketConn
			( PacketConn) LocalAddr() net.Addr
			( PacketConn) ReadFromContext(context.Context, []byte) (int, net.Addr, error)
			( PacketConn) WriteToContext(context.Context, []byte, net.Addr) (int, error)
		Implements (at least 4)
			 PacketConn : ReaderFrom
			 PacketConn : WriterTo
			 PacketConn : github.com/prometheus/common/expfmt.Closer
			 PacketConn : io.Closer
		As Outputs Of (at least one exported)
			func NewPacketConn(pconn net.PacketConn) PacketConn

	 type Reader (interface)
		Reader is an interface for context controlled reader.

		Methods (only one)
			( Reader) ReadContext(context.Context, []byte) (int, error)
		Implemented By (at least 5)
			 Conn (interface)
			 ReadWriter (interface)
			 github.com/pion/transport/v2/connctx.ConnCtx (interface)
			 github.com/pion/transport/v2/connctx.Reader (interface)
			 github.com/pion/transport/v2/connctx.ReadWriter (interface)
		Implements (at least one exported)
			 Reader : github.com/pion/transport/v2/connctx.Reader

	 type ReaderFrom (interface)
		ReaderFrom is an interface for context controlled packet reader.

		Methods (only one)
			( ReaderFrom) ReadFromContext(context.Context, []byte) (int, net.Addr, error)
		Implemented By (at least one exported)
			 PacketConn (interface)

	 type ReadWriter (interface)
		ReadWriter is a composite of ReadWriter.

		Methods (total 2)
			( ReadWriter) ReadContext(context.Context, []byte) (int, error)
			( ReadWriter) WriteContext(context.Context, []byte) (int, error)
		Implemented By (at least 3)
			 Conn (interface)
			 github.com/pion/transport/v2/connctx.ConnCtx (interface)
			 github.com/pion/transport/v2/connctx.ReadWriter (interface)
		Implements (at least 5)
			 ReadWriter : Reader
			 ReadWriter : Writer
			 ReadWriter : github.com/pion/transport/v2/connctx.Reader
			 ReadWriter : github.com/pion/transport/v2/connctx.ReadWriter
			 ReadWriter : github.com/pion/transport/v2/connctx.Writer

	 type Writer (interface)
		Writer is an interface for context controlled writer.

		Methods (only one)
			( Writer) WriteContext(context.Context, []byte) (int, error)
		Implemented By (at least 5)
			 Conn (interface)
			 ReadWriter (interface)
			 github.com/pion/transport/v2/connctx.ConnCtx (interface)
			 github.com/pion/transport/v2/connctx.ReadWriter (interface)
			 github.com/pion/transport/v2/connctx.Writer (interface)
		Implements (at least one exported)
			 Writer : github.com/pion/transport/v2/connctx.Writer

	 type WriterTo (interface)
		WriterTo is an interface for context controlled packet writer.

		Methods (only one)
			( WriterTo) WriteToContext(context.Context, []byte, net.Addr) (int, error)
		Implemented By (at least one exported)
			 PacketConn (interface)


Package-Level Functions (total 3)

	 func NewConn(netConn net.Conn) Conn
		NewConn creates a new Conn wrapping given net.Conn.

	 func NewPacketConn(pconn net.PacketConn) PacketConn
		NewPacketConn creates a new PacketConn wrapping the given net.PacketConn.

	 func Pipe() (Conn, Conn)
		Pipe creates piped pair of Conn.


Package-Level Variables (only one)

	  var ErrClosing error
		ErrClosing is returned on Write to closed connection.

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.