package connctx

Import Path
	github.com/pion/transport/v2/connctx (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	  d connctx.go
		Package connctx wraps net.Conn using context.Context.
		
		Deprecated: use netctx instead.

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

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

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

	 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)
			 ConnCtx (interface)
			 ReadWriter (interface)
			 github.com/pion/transport/v3/netctx.Conn (interface)
			 github.com/pion/transport/v3/netctx.Reader (interface)
			 github.com/pion/transport/v3/netctx.ReadWriter (interface)
		Implements (at least one exported)
			 Reader : github.com/pion/transport/v3/netctx.Reader

	 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)
			 ConnCtx (interface)
			 github.com/pion/transport/v3/netctx.Conn (interface)
			 github.com/pion/transport/v3/netctx.ReadWriter (interface)
		Implements (at least 5)
			 ReadWriter : Reader
			 ReadWriter : Writer
			 ReadWriter : github.com/pion/transport/v3/netctx.Reader
			 ReadWriter : github.com/pion/transport/v3/netctx.ReadWriter
			 ReadWriter : github.com/pion/transport/v3/netctx.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)
			 ConnCtx (interface)
			 ReadWriter (interface)
			 github.com/pion/transport/v3/netctx.Conn (interface)
			 github.com/pion/transport/v3/netctx.ReadWriter (interface)
			 github.com/pion/transport/v3/netctx.Writer (interface)
		Implements (at least one exported)
			 Writer : github.com/pion/transport/v3/netctx.Writer


Package-Level Functions (total 2)

	 func New(conn net.Conn) ConnCtx
		New creates a new ConnCtx wrapping given net.Conn.

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


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.