mux

Documentation

Index

• Constants
• func NewStreamReader(reader *buf.BufferedReader) buf.Reader
• type ClientManager
  • func (m *ClientManager) Dispatch(ctx context.Context, link *transport.Link) error
• type ClientStrategy
• type ClientWorker
  • func NewClientWorker(stream transport.Link, s ClientStrategy) (*ClientWorker, error)
  • func (m *ClientWorker) ActiveConnections() uint32
  • func (m *ClientWorker) Closed() bool
  • func (m *ClientWorker) Dispatch(ctx context.Context, link *transport.Link) bool
  • func (m *ClientWorker) IsClosing() bool
  • func (m *ClientWorker) IsFull() bool
  • func (m *ClientWorker) TotalConnections() uint32
• type ClientWorkerFactory
• type DialingWorkerFactory
  • func (f *DialingWorkerFactory) Create() (*ClientWorker, error)
• type FrameMetadata
  • func (f *FrameMetadata) Unmarshal(reader io.Reader) error
  • func (f *FrameMetadata) UnmarshalFromBuffer(b *buf.Buffer) error
  • func (f FrameMetadata) WriteTo(b *buf.Buffer) error
• type IncrementalWorkerPicker
  • func (p *IncrementalWorkerPicker) PickAvailable() (*ClientWorker, error)
• type PacketReader
  • func NewPacketReader(reader io.Reader) *PacketReader
  • func (r *PacketReader) ReadMultiBuffer() (buf.MultiBuffer, error)
• type Server
  • func NewServer(ctx context.Context) *Server
  • func (s *Server) Close() error
  • func (s *Server) Dispatch(ctx context.Context, dest net.Destination) (*transport.Link, error)
  • func (s *Server) Start() error
  • func (s *Server) Type() interface{}
• type ServerWorker
  • func NewServerWorker(ctx context.Context, d routing.Dispatcher, link *transport.Link) (*ServerWorker, error)
  • func (w *ServerWorker) ActiveConnections() uint32
  • func (w *ServerWorker) Closed() bool
• type Session
  • func (s *Session) Close() error
  • func (s *Session) NewReader(reader *buf.BufferedReader) buf.Reader
• type SessionManager
  • func NewSessionManager() *SessionManager
  • func (m *SessionManager) Add(s *Session)
  • func (m *SessionManager) Allocate() *Session
  • func (m *SessionManager) Close() error
  • func (m *SessionManager) CloseIfNoSession() bool
  • func (m *SessionManager) Closed() bool
  • func (m *SessionManager) Count() int
  • func (m *SessionManager) Get(id uint16) (*Session, bool)
  • func (m *SessionManager) Remove(id uint16)
  • func (m *SessionManager) Size() int
• type SessionStatus
• type TargetNetwork
• type WorkerPicker
• type Writer
  • func NewResponseWriter(id uint16, writer buf.Writer, transferType protocol.TransferType) *Writer
  • func NewWriter(id uint16, dest net.Destination, writer buf.Writer, ...) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) WriteMultiBuffer(mb buf.MultiBuffer) error

Constants

const (
	OptionData  bitmask.Byte = 0x01
	OptionError bitmask.Byte = 0x02
)

Functions

func NewStreamReader

func NewStreamReader(reader *buf.BufferedReader) buf.Reader

NewStreamReader creates a new StreamReader.

Types

type ClientManager

type ClientManager struct {
	Enabled bool // wheather mux is enabled from user config
	Picker  WorkerPicker
}

func (*ClientManager) Dispatch

func (m *ClientManager) Dispatch(ctx context.Context, link *transport.Link) error

type ClientStrategy

type ClientStrategy struct {
	MaxConcurrency uint32
	MaxConnection  uint32
}

type ClientWorker

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

func NewClientWorker

func NewClientWorker(stream transport.Link, s ClientStrategy) (*ClientWorker, error)

NewClientWorker creates a new mux.Client.

func (*ClientWorker) ActiveConnections

func (m *ClientWorker) ActiveConnections() uint32

func (*ClientWorker) Closed

func (m *ClientWorker) Closed() bool

Closed returns true if this Client is closed.

func (*ClientWorker) Dispatch

func (m *ClientWorker) Dispatch(ctx context.Context, link *transport.Link) bool

func (*ClientWorker) IsClosing

func (m *ClientWorker) IsClosing() bool

func (*ClientWorker) IsFull

func (m *ClientWorker) IsFull() bool

func (*ClientWorker) TotalConnections

func (m *ClientWorker) TotalConnections() uint32

type ClientWorkerFactory

type ClientWorkerFactory interface {
	Create() (*ClientWorker, error)
}

type DialingWorkerFactory

type DialingWorkerFactory struct {
	Proxy    proxy.Outbound
	Dialer   internet.Dialer
	Strategy ClientStrategy
}

func (*DialingWorkerFactory) Create

func (f *DialingWorkerFactory) Create() (*ClientWorker, error)

type FrameMetadata

type FrameMetadata struct {
	Target        net.Destination
	SessionID     uint16
	Option        bitmask.Byte
	SessionStatus SessionStatus
}

func (*FrameMetadata) Unmarshal

func (f *FrameMetadata) Unmarshal(reader io.Reader) error

Unmarshal reads FrameMetadata from the given reader.

func (*FrameMetadata) UnmarshalFromBuffer

func (f *FrameMetadata) UnmarshalFromBuffer(b *buf.Buffer) error

UnmarshalFromBuffer reads a FrameMetadata from the given buffer. Visible for testing only.

func (FrameMetadata) WriteTo

func (f FrameMetadata) WriteTo(b *buf.Buffer) error

type IncrementalWorkerPicker

type IncrementalWorkerPicker struct {
	Factory ClientWorkerFactory
	// contains filtered or unexported fields
}

func (*IncrementalWorkerPicker) PickAvailable

func (p *IncrementalWorkerPicker) PickAvailable() (*ClientWorker, error)

type PacketReader

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

PacketReader is an io.Reader that reads whole chunk of Mux frames every time.

func NewPacketReader

func NewPacketReader(reader io.Reader) *PacketReader

NewPacketReader creates a new PacketReader.

func (*PacketReader) ReadMultiBuffer

func (r *PacketReader) ReadMultiBuffer() (buf.MultiBuffer, error)

ReadMultiBuffer implements buf.Reader.

type Server

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

func NewServer

func NewServer(ctx context.Context) *Server

NewServer creates a new mux.Server.

func (*Server) Close

func (s *Server) Close() error

Close implements common.Closable.

func (*Server) Dispatch

func (s *Server) Dispatch(ctx context.Context, dest net.Destination) (*transport.Link, error)

Dispatch implements routing.Dispatcher

func (*Server) Start

func (s *Server) Start() error

Start implements common.Runnable.

func (*Server) Type

func (s *Server) Type() interface{}

Type implements common.HasType.

type ServerWorker

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

func NewServerWorker

func NewServerWorker(ctx context.Context, d routing.Dispatcher, link *transport.Link) (*ServerWorker, error)

func (*ServerWorker) ActiveConnections

func (w *ServerWorker) ActiveConnections() uint32

func (*ServerWorker) Closed

func (w *ServerWorker) Closed() bool

type Session

type Session struct {
	ID uint16
	// contains filtered or unexported fields
}

Session represents a client connection in a Mux connection.

func (*Session) Close

func (s *Session) Close() error

Close closes all resources associated with this session.

func (*Session) NewReader

func (s *Session) NewReader(reader *buf.BufferedReader) buf.Reader

NewReader creates a buf.Reader based on the transfer type of this Session.

type SessionManager

type SessionManager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewSessionManager

func NewSessionManager() *SessionManager

func (*SessionManager) Add

func (m *SessionManager) Add(s *Session)

func (*SessionManager) Allocate

func (m *SessionManager) Allocate() *Session

func (*SessionManager) Close

func (m *SessionManager) Close() error

func (*SessionManager) CloseIfNoSession

func (m *SessionManager) CloseIfNoSession() bool

func (*SessionManager) Closed

func (m *SessionManager) Closed() bool

func (*SessionManager) Count

func (m *SessionManager) Count() int

func (*SessionManager) Get

func (m *SessionManager) Get(id uint16) (*Session, bool)

func (*SessionManager) Remove

func (m *SessionManager) Remove(id uint16)

func (*SessionManager) Size

func (m *SessionManager) Size() int

type SessionStatus

type SessionStatus byte

const (
	SessionStatusNew       SessionStatus = 0x01
	SessionStatusKeep      SessionStatus = 0x02
	SessionStatusEnd       SessionStatus = 0x03
	SessionStatusKeepAlive SessionStatus = 0x04
)

type TargetNetwork

type TargetNetwork byte

const (
	TargetNetworkTCP TargetNetwork = 0x01
	TargetNetworkUDP TargetNetwork = 0x02
)

type WorkerPicker

type WorkerPicker interface {
	PickAvailable() (*ClientWorker, error)
}

type Writer

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

func NewResponseWriter

func NewResponseWriter(id uint16, writer buf.Writer, transferType protocol.TransferType) *Writer

func NewWriter

func NewWriter(id uint16, dest net.Destination, writer buf.Writer, transferType protocol.TransferType) *Writer

func (*Writer) Close

func (w *Writer) Close() error

Close implements common.Closable.

func (*Writer) WriteMultiBuffer

func (w *Writer) WriteMultiBuffer(mb buf.MultiBuffer) error

WriteMultiBuffer implements buf.Writer.