package yamux

Import Path
	github.com/libp2p/go-yamux/v5 (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	    addr.go
	    const.go
	    deadline.go
	    mux.go
	    ping.go
	    session.go
	    stream.go
	    util.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config is used to tune the Yamux session

		Fields (total 13)
			AcceptBacklog int
				AcceptBacklog is used to limit how many streams may be
				waiting an accept.

			ConnectionWriteTimeout time.Duration
				ConnectionWriteTimeout is meant to be a "safety valve" timeout after
				we which will suspect a problem with the underlying connection and
				close it. This is only applied to writes, where's there's generally
				an expectation that things will move along quickly.

			EnableKeepAlive bool
				EnableKeepalive is used to do a period keep alive
				messages using a ping.

			InitialStreamWindowSize uint32
				InitialStreamWindowSize is used to control the initial
				window size that we allow for a stream.

			KeepAliveInterval time.Duration
				KeepAliveInterval is how often to perform the keep alive

			LogOutput io.Writer
				LogOutput is used to control the log destination

			MaxIncomingStreams uint32
				MaxIncomingStreams is maximum number of concurrent incoming streams
				that we accept. If the peer tries to open more streams, those will be
				reset immediately.

			MaxMessageSize uint32
				MaxMessageSize is the maximum size of a message that we'll send on a
				stream. This ensures that a single stream doesn't hog a connection.

			MaxStreamWindowSize uint32
				MaxStreamWindowSize is used to control the maximum
				window size that we allow for a stream.

			MeasureRTTInterval time.Duration
				MeasureRTTInterval is how often to re-measure the round trip time

			PingBacklog int
				PingBacklog is used to limit how many ping acks we can queue.

			ReadBufSize int
				ReadBufSize controls the size of the read buffer.
				
				Set to 0 to disable it.

			WriteCoalesceDelay time.Duration
				WriteCoalesceDelay is the maximum amount of time we'll delay
				coalescing a packet before sending it. This should be on the order of
				micro-milliseconds.

		As Outputs Of (at least 2)
			func DefaultConfig() *Config
			func github.com/libp2p/go-libp2p/p2p/muxer/yamux.(*Transport).Config() *Config
		As Inputs Of (at least 3)
			func Client(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
			func Server(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
			func VerifyConfig(config *Config) error

	 type Error (struct)

		Methods (total 3)
			(*Error) Error() string
			(*Error) Temporary() bool
			(*Error) Timeout() bool
		Implements (at least 3)
			*Error : github.com/jbenet/go-temp-err-catcher.Temporary
			*Error : error
			*Error : net.Error
		As Types Of (total 11)
			  var ErrConnectionWriteTimeout *Error
			  var ErrDuplicateStream *Error
			  var ErrInvalidMsgType *Error
			  var ErrInvalidVersion *Error
			  var ErrKeepAliveTimeout *Error
			  var ErrRecvWindowExceeded *Error
			  var ErrStreamClosed *Error
			  var ErrStreamReset *Error
			  var ErrStreamsExhausted *Error
			  var ErrTimeout *Error
			  var ErrUnexpectedFlag *Error

	 type GoAwayError (struct)

		Fields (total 2)
			ErrorCode uint32
			Remote bool
		Methods (total 4)
			(*GoAwayError) Error() string
			(*GoAwayError) Is(target error) bool
			(*GoAwayError) Temporary() bool
			(*GoAwayError) Timeout() bool
		Implements (at least 3)
			*GoAwayError : github.com/jbenet/go-temp-err-catcher.Temporary
			*GoAwayError : error
			*GoAwayError : net.Error
		As Types Of (total 2)
			  var ErrRemoteGoAway *GoAwayError
			  var ErrSessionShutdown *GoAwayError

	 type MemoryManager (interface)
		The MemoryManager allows management of memory allocations.
		Memory is allocated:
		1. When opening / accepting a new stream. This uses the highest priority.
		2. When trying to increase the stream receive window. This uses a lower priority.
		This is a subset of the libp2p's resource manager ResourceScopeSpan interface.

		Methods (total 3)
			( MemoryManager) Done()
				Done ends the span and releases associated resources.

			( MemoryManager) ReleaseMemory(size int)
				ReleaseMemory explicitly releases memory previously reserved with ReserveMemory

			( MemoryManager) ReserveMemory(size int, prio uint8) error
		Implemented By (at least 4)
			 github.com/libp2p/go-libp2p/core/network.ConnManagementScope (interface)
			*github.com/libp2p/go-libp2p/core/network.NullScope
			 github.com/libp2p/go-libp2p/core/network.ResourceScopeSpan (interface)
			 github.com/libp2p/go-libp2p/core/network.StreamManagementScope (interface)

	 type Session (struct)
		Session is used to wrap a reliable ordered connection and to
		multiplex it into multiple streams.

		Methods (total 14)
			(*Session) Accept() (net.Conn, error)
				Accept is used to block until the next available stream
				is ready to be accepted.

			(*Session) AcceptStream() (*Stream, error)
				AcceptStream is used to block until the next available stream
				is ready to be accepted.

			(*Session) Addr() net.Addr
				Addr is used to get the address of the listener.

			(*Session) Close() error
				Close is used to close the session and all streams. It doesn't send a GoAway before
				closing the connection.

			(*Session) CloseChan() <-chan struct{}
				CloseChan returns a read-only channel which is closed as
				soon as the session is closed.

			(*Session) CloseWithError(errCode uint32) error
				CloseWithError is used to close the session and all streams after sending a GoAway message with errCode.
				Blocks for ConnectionWriteTimeout to write the GoAway message.
				
				The GoAway may not actually be sent depending on the semantics of the underlying net.Conn.
				For TCP connections, it may be dropped depending on LINGER value or if there's unread data in the kernel
				receive buffer.

			(*Session) GoAway() error
				GoAway can be used to prevent accepting further
				connections. It does not close the underlying conn.

			(*Session) IsClosed() bool
				IsClosed does a safe check to see if we have shutdown

			(*Session) LocalAddr() net.Addr
				LocalAddr is used to get the local address of the
				underlying connection.

			(*Session) NumStreams() int
				NumStreams returns the number of currently open streams

			(*Session) Open(ctx context.Context) (net.Conn, error)
				Open is used to create a new stream as a net.Conn

			(*Session) OpenStream(ctx context.Context) (*Stream, error)
				OpenStream is used to create a new stream

			(*Session) Ping() (dur time.Duration, err error)
				Ping is used to measure the RTT response time

			(*Session) RemoteAddr() net.Addr
				RemoteAddr is used to get the address of remote end
				of the underlying connection

		Implements (at least 3)
			*Session : github.com/prometheus/common/expfmt.Closer
			*Session : io.Closer
			*Session : net.Listener
		As Outputs Of (at least 3)
			func Client(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
			func Server(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
			func (*Stream).Session() *Session
		As Inputs Of (at least one exported)
			func github.com/libp2p/go-libp2p/p2p/muxer/yamux.NewMuxedConn(m *Session) network.MuxedConn

	 type Stream (struct)
		Stream is used to represent a logical stream
		within a session.

		Methods (total 14)
			(*Stream) Close() error
				Close is used to close the stream.

			(*Stream) CloseRead() error
				CloseRead is used to close the stream for reading.
				Note: Remote is not notified.

			(*Stream) CloseWrite() error
				CloseWrite is used to close the stream for writing.

			(*Stream) LocalAddr() net.Addr
				LocalAddr returns the local address

			(*Stream) Read(b []byte) (n int, err error)
				Read is used to read from the stream

			(*Stream) RemoteAddr() net.Addr
				RemoteAddr returns the remote address

			(*Stream) Reset() error
				Reset resets the stream (forcibly closes the stream)

			(*Stream) ResetWithError(errCode uint32) error
			(*Stream) Session() *Session
				Session returns the associated stream session

			(*Stream) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines

			(*Stream) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls.

			(*Stream) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls

			(*Stream) StreamID() uint32
				StreamID returns the ID of this stream

			(*Stream) Write(b []byte) (int, error)
				Write is used to write to the stream

		Implements (at least 15)
			*Stream : github.com/miekg/dns.Writer
			*Stream : github.com/pion/datachannel.ReadDeadliner
			*Stream : github.com/pion/datachannel.WriteDeadliner
			*Stream : github.com/pion/stun.Connection
			*Stream : github.com/pion/stun/v3.Connection
			*Stream : github.com/prometheus/common/expfmt.Closer
			*Stream : internal/bisect.Writer
			*Stream : io.Closer
			*Stream : io.ReadCloser
			*Stream : io.Reader
			*Stream : io.ReadWriteCloser
			*Stream : io.ReadWriter
			*Stream : io.WriteCloser
			*Stream : io.Writer
			*Stream : net.Conn
		As Outputs Of (at least 2)
			func (*Session).AcceptStream() (*Stream, error)
			func (*Session).OpenStream(ctx context.Context) (*Stream, error)

	 type StreamError (struct)
		A StreamError is used for errors returned from Read and Write calls after the stream is Reset

		Fields (total 2)
			ErrorCode uint32
			Remote bool
		Methods (total 2)
			(*StreamError) Error() string
			(*StreamError) Is(target error) bool
		Implements (at least one exported)
			*StreamError : error


Package-Level Functions (total 4)

	 func Client(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
		Client is used to initialize a new client-side connection.
		There must be at most one client-side connection.

	 func DefaultConfig() *Config
		DefaultConfig is used to return a default configuration

	 func Server(conn net.Conn, config *Config, mm func() (MemoryManager, error)) (*Session, error)
		Server is used to initialize a new server-side connection.
		There must be at most one server-side connection. If a nil config is
		provided, the DefaultConfiguration will be used.

	 func VerifyConfig(config *Config) error
		VerifyConfig is used to verify the sanity of configuration


Package-Level Variables (total 13)

	  var ErrConnectionWriteTimeout *Error
		ErrConnectionWriteTimeout indicates that we hit the "safety valve"
		timeout writing to the underlying stream connection.

	  var ErrDuplicateStream *Error
		ErrDuplicateStream is used if a duplicate stream is
		opened inbound

	  var ErrInvalidMsgType *Error
		ErrInvalidMsgType means we received a frame with an
		invalid message type

	  var ErrInvalidVersion *Error
		ErrInvalidVersion means we received a frame with an
		invalid version

	  var ErrKeepAliveTimeout *Error
		ErrKeepAliveTimeout is sent if a missed keepalive caused the stream close

	  var ErrRecvWindowExceeded *Error
		ErrReceiveWindowExceeded indicates the window was exceeded

	  var ErrRemoteGoAway *GoAwayError
		ErrRemoteGoAway is used when we get a go away from the other side with error code
		goAwayNormal(0).

	  var ErrSessionShutdown *GoAwayError
		ErrSessionShutdown is used if there is a shutdown during
		an operation

	  var ErrStreamClosed *Error
		ErrStreamClosed is returned when using a closed stream

	  var ErrStreamReset *Error
		ErrStreamReset is sent if a stream is reset. This can happen
		if the backlog is exceeded, or if there was a remote GoAway.

	  var ErrStreamsExhausted *Error
		ErrStreamsExhausted is returned if we have no more
		stream ids to issue

	  var ErrTimeout *Error
		ErrTimeout is used when we reach an IO deadline

	  var ErrUnexpectedFlag *Error
		ErrUnexpectedFlag is set when we get an unexpected flag

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.