transport

Documentation

Index

• Constants
• type Conn
  • func NewTCP(cfg TCPConnConfig) (Conn, error)
• type ConnConfig
• type ErrCode
  • func (e ErrCode) Error() string
• type ErrNotMultiple
  • func (e *ErrNotMultiple) Error() string
• type Mode
• type ModeConfig
• type Reader
  • func NewReader(ctx context.Context, r io.Reader) *Reader
  • func (c *Reader) Read(p []byte) (int, error)
  • func (c *Reader) ReadByte() (byte, error)
• type TCPConnConfig
• type Transport
  • func NewTransport(m messages.MessageInformator, conn ConnConfig, modeVariant mode.Variant) (Transport, error)

Constants

const DefaultTimeout = 5 * time.Second

Types

type Conn

type Conn io.ReadWriteCloser

func NewTCP

func NewTCP(cfg TCPConnConfig) (Conn, error)

type ConnConfig

type ConnConfig interface{}

type ErrCode

type ErrCode int64

func (ErrCode) Error

func (e ErrCode) Error() string

type ErrNotMultiple

type ErrNotMultiple struct {
	Len int
}

func (*ErrNotMultiple) Error

func (e *ErrNotMultiple) Error() string

type Mode

type Mode interface {
	WriteMsg(msg []byte) error // this is not same as the io.Writer
	ReadMsg() ([]byte, error)
}

type ModeConfig

type ModeConfig = func(Conn) (Mode, error)

type Reader

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

Reader is a wrapper around io.Reader, that allows to cancel read operation.

func NewReader

func NewReader(ctx context.Context, r io.Reader) *Reader

func (*Reader) Read

func (c *Reader) Read(p []byte) (int, error)

func (*Reader) ReadByte

func (c *Reader) ReadByte() (byte, error)

type TCPConnConfig

type TCPConnConfig struct {
	Ctx     context.Context
	Host    string
	Timeout time.Duration
	Socks   *url.URL
}

type Transport

type Transport interface {
	Close() error
	WriteMsg(msg messages.Common, seqNo int32) error
	ReadMsg() (messages.Common, error)
}

func NewTransport

func NewTransport(m messages.MessageInformator, conn ConnConfig, modeVariant mode.Variant) (Transport, error)