transport

Documentation

Overview

Package transport contains different MTProto transport implementations.

Index

• type Codec
• type Conn
• type DialFunc
  • func (d DialFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type Dialer
• type Handler
• type Server
  • func NewCustomServer(c func() Codec, listener net.Listener) *Server
  • func NewFullServer(listener net.Listener) *Server
  • func NewIntermediateServer(listener net.Listener) *Server
  • func (s *Server) Addr() net.Addr
  • func (s *Server) Close() error
  • func (s *Server) Serve(ctx context.Context, handler Handler) error
• type Transport
  • func Abridged(d Dialer) *Transport
  • func Full(d Dialer) *Transport
  • func Intermediate(d Dialer) *Transport
  • func MTProxy(d Dialer, dc int, secret []byte) (*Transport, error)
  • func NewTransport(dialer Dialer, getCodec func() Codec) *Transport
  • func PaddedIntermediate(d Dialer) *Transport
  • func (t *Transport) Codec() Codec
  • func (t *Transport) DialContext(ctx context.Context, network, address string) (Conn, error)

Types

type Codec

type Codec interface {
	// WriteHeader sends protocol tag if needed.
	WriteHeader(w io.Writer) error
	// ReadHeader reads protocol tag if needed.
	ReadHeader(r io.Reader) error
	// Write encode to writer message from given buffer.
	Write(w io.Writer, b *bin.Buffer) error
	// Read fills buffer with received message.
	Read(r io.Reader, b *bin.Buffer) error
}

Codec is MTProto transport protocol encoding abstraction.

type Conn

type Conn interface {
	Send(ctx context.Context, b *bin.Buffer) error
	Recv(ctx context.Context, b *bin.Buffer) error
	Close() error
}

Conn is transport connection.

type DialFunc

type DialFunc func(ctx context.Context, network, address string) (net.Conn, error)

DialFunc is functional helper for Dialer.

func (DialFunc) DialContext

func (d DialFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)

DialContext implements Dialer.

type Dialer

type Dialer interface {
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

Dialer dials using a context.

type Handler

type Handler func(ctx context.Context, conn Conn) error

Handler is MTProto server connection handler.

type Server

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

Server is a simple MTProto server.

func NewCustomServer

func NewCustomServer(c func() Codec, listener net.Listener) *Server

NewCustomServer creates new MTProto server with custom transport codec.

func NewFullServer

func NewFullServer(listener net.Listener) *Server

NewFullServer creates new MTProto server with Full transport codec.

func NewIntermediateServer

func NewIntermediateServer(listener net.Listener) *Server

NewIntermediateServer creates new MTProto server with Intermediate transport codec.

func (*Server) Addr

func (s *Server) Addr() net.Addr

Addr returns server address.

func (*Server) Close

func (s *Server) Close() error

Close stops server and closes given listener.

func (*Server) Serve

func (s *Server) Serve(ctx context.Context, handler Handler) error

Serve runs server using given listener.

type Transport

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

Transport is MTProto connection creator.

func Abridged

func Abridged(d Dialer) *Transport

Abridged creates Abridged transport.

See https://core.telegram.org/mtproto/mtproto-transports#abridged

func Full

func Full(d Dialer) *Transport

Full creates Full transport.

See https://core.telegram.org/mtproto/mtproto-transports#full

func Intermediate

func Intermediate(d Dialer) *Transport

Intermediate creates Intermediate transport.

See https://core.telegram.org/mtproto/mtproto-transports#intermediate

func MTProxy

func MTProxy(d Dialer, dc int, secret []byte) (*Transport, error)

MTProxy creates MTProxy obfuscated transport.

See https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation

func NewTransport

func NewTransport(dialer Dialer, getCodec func() Codec) *Transport

NewTransport creates transport using user Codec constructor.

func PaddedIntermediate

func PaddedIntermediate(d Dialer) *Transport

PaddedIntermediate creates Padded intermediate transport.

See https://core.telegram.org/mtproto/mtproto-transports#padded-intermediate

func (*Transport) Codec

func (t *Transport) Codec() Codec

Codec creates new codec using transport settings.

func (*Transport) DialContext

func (t *Transport) DialContext(ctx context.Context, network, address string) (Conn, error)

DialContext creates new MTProto connection.