mux

Documentation

Overview

Package mux provides a generic muxing API.

Index

• func Wait(sess Session) error
• type Channel
• type Session
• type Transport

Functions

func Wait

func Wait(sess Session) error

Wait blocks until the session transport has shut down, and returns the error causing the shutdown.

Types

type Channel

type Channel interface {
	// Read reads up to len(data) bytes from the channel.
	Read(data []byte) (int, error)

	// Write writes len(data) bytes to the channel.
	Write(data []byte) (int, error)

	// Close signals end of channel use. No data may be sent after this
	// call.
	Close() error

	// CloseWrite signals the end of sending data.
	// The other side may still send data
	CloseWrite() error

	// ID returns the unique identifier of this channel
	// within the session
	ID() uint32
}

Channel is an ordered, reliable, flow-controlled, duplex stream that is multiplexed over a qmux session.

type Session

type Session interface {
	// Close closes the underlying transport.
	// Any blocked Accept operations will be unblocked and return errors.
	Close() error

	// Open establishes a new channel with the other end.
	Open(ctx context.Context) (Channel, error)

	// Accept waits for and returns the next incoming channel.
	Accept() (Channel, error)
}

Session is a bi-directional channel muxing session on a given transport.

type Transport

type Transport interface {
	io.Reader
	io.Writer
	io.Closer
}

Transport is an interface describing what is needed for a session