mux

Documentation

Index

• Variables
• type Mux
  • func Client(conn net.Conn, psk string) *Mux
  • func Server(conn net.Conn, psk string) *Mux
  • func (m *Mux) AcceptStream() (net.Conn, error)
  • func (m *Mux) Close() error
  • func (m *Mux) OpenStream() (net.Conn, error)
• type Stream
  • func (s *Stream) Close() error
  • func (s *Stream) LocalAddr() net.Addr
  • func (s *Stream) Read(p []byte) (int, error)
  • func (s *Stream) RemoteAddr() net.Addr
  • func (s *Stream) SetDeadline(t time.Time) error
  • func (s *Stream) SetReadDeadline(t time.Time) error
  • func (s *Stream) SetWriteDeadline(t time.Time) error
  • func (s *Stream) Write(p []byte) (int, error)

Variables

var (
	ErrClosedConn       = errors.New("underlying connection was closed")
	ErrClosedStream     = errors.New("stream was gracefully closed")
	ErrPeerClosedStream = errors.New("peer closed stream gracefully")
	ErrPeerClosedConn   = errors.New("peer closed mux gracefully")
	ErrWriteClosed      = errors.New("write end of stream closed")
)

Errors relating to stream or mux shutdown.

Types

type Mux

type Mux struct {
	// contains filtered or unexported fields
}

A Mux multiplexes multiple duplex Streams onto a single net.Conn.

func Client

func Client(conn net.Conn, psk string) *Mux

Client creates and initializes a new client-side Mux on the provided conn. Client takes overship of the conn.

func Server

func Server(conn net.Conn, psk string) *Mux

Server creates and initializes a new server-side Mux on the provided conn. Server takes overship of the conn.

func (*Mux) AcceptStream

func (m *Mux) AcceptStream() (net.Conn, error)

AcceptStream waits for and returns the next peer-initiated Stream.

func (*Mux) Close

func (m *Mux) Close() error

Close closes the underlying net.Conn.

func (*Mux) OpenStream

func (m *Mux) OpenStream() (net.Conn, error)

OpenStream creates a new Stream.

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

A Stream is a duplex connection multiplexed over a net.Conn. It implements the net.Conn interface.

func (*Stream) Close

func (s *Stream) Close() error

Close closes the Stream. The underlying connection is not closed.

func (*Stream) LocalAddr

func (s *Stream) LocalAddr() net.Addr

LocalAddr returns the underlying connection's LocalAddr.

func (*Stream) Read

func (s *Stream) Read(p []byte) (int, error)

Read reads data from the Stream.

func (*Stream) RemoteAddr

func (s *Stream) RemoteAddr() net.Addr

RemoteAddr returns the underlying connection's RemoteAddr.

func (*Stream) SetDeadline

func (s *Stream) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with the Stream. It is equivalent to calling both SetReadDeadline and SetWriteDeadline.

This implementation does not entirely conform to the net.Conn interface: setting a new deadline does not affect pending Read or Write calls, only future calls.

func (*Stream) SetReadDeadline

func (s *Stream) SetReadDeadline(t time.Time) error

SetReadDeadline sets the read deadline associated with the Stream.

This implementation does not entirely conform to the net.Conn interface: setting a new deadline does not affect pending Read calls, only future calls.

func (*Stream) SetWriteDeadline

func (s *Stream) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the write deadline associated with the Stream.

This implementation does not entirely conform to the net.Conn interface: setting a new deadline does not affect pending Write calls, only future calls.

func (*Stream) Write

func (s *Stream) Write(p []byte) (int, error)

Write writes data to the Stream.