package yamux

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

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	    conn.go
	    stream.go
	    transport.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Transport yamux.Config (struct)
		Transport implements mux.Multiplexer that constructs
		yamux-backed muxed connections.

		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.

		Methods (total 2)
			(*Transport) Config() *yamux.Config
			(*Transport) NewConn(nc net.Conn, isServer bool, scope network.PeerScope) (network.MuxedConn, error)
		Implements (at least one exported)
			*Transport : github.com/libp2p/go-libp2p/core/network.Multiplexer
		As Types Of (only one)
			  var DefaultTransport *Transport


Package-Level Functions (only one)

	 func NewMuxedConn(m *yamux.Session) network.MuxedConn
		NewMuxedConn constructs a new MuxedConn from a yamux.Session.


Package-Level Variables (only one)

	  var DefaultTransport *Transport
Package-Level Constants (only one)

	const ID = "/yamux/1.0.0"

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.