package transport

Import Path
	github.com/gotd/td/transport (on go.dev)

Dependency Relation
	imports 15 packages, and imported by 4 packages

Involved Source Files

	    codec.go
	    connection.go
	    detect_codec.go
	  d doc.go
		Package transport contains different MTProto transport
		implementations.

	    listener.go
	    obfuscated.go
	    once_close.go
	    protocol.go
	    websocket.go
Package-Level Type Names (total 11, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Codec (interface)
		Codec is MTProto transport protocol encoding abstraction.

		Methods (total 4, all are exported)
			( Codec) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

			( Codec) ReadHeader(r io.Reader) error
				ReadHeader reads protocol tag if needed.

			( Codec) Write(w io.Writer, b *bin.Buffer) error
				Write encode to writer message from given buffer.

			( Codec) WriteHeader(w io.Writer) error
				WriteHeader sends protocol tag if needed.

		Implemented By (at least 7, all are exported)
			 github.com/gotd/td/internal/proto/codec.Abridged
			 github.com/gotd/td/internal/proto/codec.Codec (interface)
			*github.com/gotd/td/internal/proto/codec.Full
			 github.com/gotd/td/internal/proto/codec.Intermediate
			 github.com/gotd/td/internal/proto/codec.NoHeader
			 github.com/gotd/td/internal/proto/codec.PaddedIntermediate
			 github.com/gotd/td/internal/proto/codec.TaggedCodec (interface)
		Implements (at least one exported)
			 Codec : github.com/gotd/td/internal/proto/codec.Codec
		As Outputs Of (at least 4, in which 3 are exported)
			func Protocol.Codec() Codec
			func Protocol.CodecNoHeader() Codec
			func github.com/gotd/td/telegram/dcs.Protocol.Codec() Codec
			/* at least one unexported ... *//* at least one unexported: */
			func detectCodec(c io.Reader) (Codec, io.Reader, error)

	 type Conn (interface)
		Conn is transport connection.

		Methods (total 3, all are exported)
			( Conn) Close() error
			( Conn) Recv(ctx context.Context, b *bin.Buffer) error
			( Conn) Send(ctx context.Context, b *bin.Buffer) error
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*connection
		Implements (at least one exported)
			 Conn : io.Closer
		As Outputs Of (at least 7, all are exported)
			func Listener.Accept() (_ Conn, rErr error)
			func Protocol.Handshake(conn net.Conn) (Conn, error)
			func Protocol.Pipe() (a, b Conn)
			func github.com/gotd/td/telegram/dcs.Protocol.Handshake(conn net.Conn) (Conn, error)
			func github.com/gotd/td/telegram/dcs.Resolver.CDN(ctx context.Context, dc int, list dcs.List) (Conn, error)
			func github.com/gotd/td/telegram/dcs.Resolver.MediaOnly(ctx context.Context, dc int, list dcs.List) (Conn, error)
			func github.com/gotd/td/telegram/dcs.Resolver.Primary(ctx context.Context, dc int, list dcs.List) (Conn, error)
		As Inputs Of (at least one exported)
			func github.com/gotd/td/internal/exchange.NewExchanger(conn Conn, dc int) exchange.Exchanger

	 type Listener (struct)
		Listener is a simple net.Listener wrapper for listening
		MTProto transport connections.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			codec func() Codec
			listener net.Listener
		Methods (total 3, all are exported)
			( Listener) Accept() (_ Conn, rErr error)
				Accept waits for and returns the next connection to the listener.

			( Listener) Addr() net.Addr
				Addr returns the listener's network address.

			( Listener) Close() error
				Close closes the listener.
				Any blocked Accept operations will be unblocked and return errors.

		Implements (at least one exported)
			 Listener : io.Closer
		As Outputs Of (at least 2, both are exported)
			func Listen(listener net.Listener) Listener
			func ListenCodec(codec func() Codec, listener net.Listener) Listener

	 type Protocol (struct)
		Protocol is MTProto transport protocol.
		
		See https://core.telegram.org/mtproto/mtproto-transports

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			codec func() Codec
		Methods (total 4, all are exported)
			( Protocol) Codec() Codec
				Codec creates new codec using protocol settings.

			( Protocol) CodecNoHeader() Codec
				CodecNoHeader is Codec without header.

			( Protocol) Handshake(conn net.Conn) (Conn, error)
				Handshake inits given net.Conn as MTProto connection.

			( Protocol) Pipe() (a, b Conn)
				Pipe creates an in-memory MTProto connection.

		Implements (at least 2, in which 1 is exported)
			 Protocol : github.com/gotd/td/telegram/dcs.Protocol
			/* at least one unexported ... *//* at least one unexported: */
			 Protocol : github.com/gotd/td/telegram/dcs.protocol
		As Outputs Of (at least one exported)
			func NewProtocol(getCodec func() Codec) Protocol
		As Types Of (total 4, all are exported)
			  var Abridged
			  var Full
			  var Intermediate
			  var PaddedIntermediate

	/* 7 unexporteds ... *//* 7 unexporteds: */
	 type connection (struct)
		connection is MTProto connection.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			codec Codec
			conn net.Conn
			readMux sync.Mutex
			writeMux sync.Mutex
		Methods (total 3, all are exported)
			(*connection) Close() error
				Close closes MTProto connection.

			(*connection) Recv(ctx context.Context, b *bin.Buffer) error
				Recv reads message to buffer using MTProto connection.

			(*connection) Send(ctx context.Context, b *bin.Buffer) error
				Send sends message from buffer using MTProto connection.

		Implements (at least 2, both are exported)
			*connection : Conn
			*connection : io.Closer

	 type obfConn (struct)

		Fields (total 3, in which 1 is exported)
			Conn net.Conn
			/* 2 unexporteds ... *//* 2 unexporteds: */
			reader io.Reader
			writer io.Writer
		Methods (total 8, all are exported)
			( obfConn) Close() error
				Close closes the connection.
				Any blocked Read or Write operations will be unblocked and return errors.

			( obfConn) LocalAddr() net.Addr
				LocalAddr returns the local network address, if known.

			(*obfConn) Read(p []byte) (int, error)
			( obfConn) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address, if known.

			( obfConn) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.
				
				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.
				
				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.
				
				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.
				
				A zero value for t means I/O operations will not time out.

			( obfConn) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( obfConn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			(*obfConn) Write(p []byte) (int, error)
		Implements (at least 10, in which 9 are exported)
			*obfConn : internal/bisect.Writer
			 obfConn : io.Closer
			*obfConn : io.ReadCloser
			*obfConn : io.Reader
			*obfConn : io.ReadWriteCloser
			*obfConn : io.ReadWriter
			*obfConn : io.WriteCloser
			*obfConn : io.Writer
			*obfConn : net.Conn
			/* at least one unexported ... *//* at least one unexported: */
			*obfConn : crypto/tls.transcriptHash

	 type obfListener (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			listener net.Listener
		Methods (total 3, all are exported)
			( obfListener) Accept() (_ net.Conn, err error)
				Accept waits for and returns the next connection to the listener.

			( obfListener) Addr() net.Addr
				Addr returns the listener's network address.

			( obfListener) Close() error
				Close closes the listener.
				Any blocked Accept operations will be unblocked and return errors.

		Implements (at least 2, both are exported)
			 obfListener : io.Closer
			 obfListener : net.Listener

	 type onceCloseListener (struct)
		onceCloseListener wraps a net.Listener, protecting it from
		multiple Close calls.

		Fields (total 3, in which 1 is exported)
			Listener net.Listener
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
			once sync.Once
		Methods (total 3, all are exported)
			( onceCloseListener) Accept() (net.Conn, error)
				Accept waits for and returns the next connection to the listener.

			( onceCloseListener) Addr() net.Addr
				Addr returns the listener's network address.

			(*onceCloseListener) Close() error
		Implements (at least 2, both are exported)
			*onceCloseListener : io.Closer
			*onceCloseListener : net.Listener

	 type wrappedConn (struct)

		Fields (total 2, in which 1 is exported)
			Conn net.Conn
			/* one unexported ... *//* one unexported: */
			reader io.Reader
		Methods (total 8, all are exported)
			( wrappedConn) Close() error
				Close closes the connection.
				Any blocked Read or Write operations will be unblocked and return errors.

			( wrappedConn) LocalAddr() net.Addr
				LocalAddr returns the local network address, if known.

			( wrappedConn) Read(b []byte) (int, error)
			( wrappedConn) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address, if known.

			( wrappedConn) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.
				
				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.
				
				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.
				
				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.
				
				A zero value for t means I/O operations will not time out.

			( wrappedConn) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( wrappedConn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			( wrappedConn) Write(b []byte) (n int, err error)
				Write writes data to the connection.
				Write can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetWriteDeadline.

		Implements (at least 10, in which 9 are exported)
			 wrappedConn : internal/bisect.Writer
			 wrappedConn : io.Closer
			 wrappedConn : io.ReadCloser
			 wrappedConn : io.Reader
			 wrappedConn : io.ReadWriteCloser
			 wrappedConn : io.ReadWriter
			 wrappedConn : io.WriteCloser
			 wrappedConn : io.Writer
			 wrappedConn : net.Conn
			/* at least one unexported ... *//* at least one unexported: */
			 wrappedConn : crypto/tls.transcriptHash

	 type wsListener (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			addr net.Addr
			ch chan *wsServerConn
			closed *tdsync.Ready
		Methods (total 4, all are exported)
			( wsListener) Accept() (net.Conn, error)
			( wsListener) Addr() net.Addr
			( wsListener) Close() error
			( wsListener) ServeHTTP(w http.ResponseWriter, r *http.Request)
		Implements (at least 3, all are exported)
			 wsListener : io.Closer
			 wsListener : net.Listener
			 wsListener : net/http.Handler

	 type wsServerConn (struct)

		Fields (total 4, in which 1 is exported)
			Conn net.Conn
			/* 3 unexporteds ... *//* 3 unexporteds: */
			closed tdsync.Ready
			reader io.Reader
			writer io.Writer
		Methods (total 8, all are exported)
			(*wsServerConn) Close() error
			( wsServerConn) LocalAddr() net.Addr
				LocalAddr returns the local network address, if known.

			(*wsServerConn) Read(p []byte) (int, error)
			( wsServerConn) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address, if known.

			( wsServerConn) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.
				
				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.
				
				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.
				
				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.
				
				A zero value for t means I/O operations will not time out.

			( wsServerConn) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( wsServerConn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			(*wsServerConn) Write(p []byte) (int, error)
		Implements (at least 10, in which 9 are exported)
			*wsServerConn : internal/bisect.Writer
			*wsServerConn : io.Closer
			*wsServerConn : io.ReadCloser
			*wsServerConn : io.Reader
			*wsServerConn : io.ReadWriteCloser
			*wsServerConn : io.ReadWriter
			*wsServerConn : io.WriteCloser
			*wsServerConn : io.Writer
			*wsServerConn : net.Conn
			/* at least one unexported ... *//* at least one unexported: */
			*wsServerConn : crypto/tls.transcriptHash


Package-Level Functions (total 6, in which 5 are exported)

	 func Listen(listener net.Listener) Listener
		Listen creates new Listener using given net.Listener.
		Transport codec will be detected automatically.

	 func ListenCodec(codec func() Codec, listener net.Listener) Listener
		ListenCodec creates new Listener using given net.Listener.
		Listener will always use given Codec constructor.

	 func NewProtocol(getCodec func() Codec) Protocol
		NewProtocol creates new transport protocol using user Codec constructor.
		
		See https://core.telegram.org/mtproto/mtproto-transports

	 func ObfuscatedListener(listener net.Listener) net.Listener
		ObfuscatedListener creates new obfuscated2 listener using given net.Listener.
		
		Useful for creating Telegram servers:
		
			transport.Listen(transport.ObfuscatedListener(ln))

	 func WebsocketListener(addr net.Addr) (net.Listener, http.Handler)
		WebsocketListener creates new MTProto Websocket listener.

	/* one unexported ... *//* one unexported: */
	 func detectCodec(c io.Reader) (Codec, io.Reader, error)
Package-Level Variables (total 4, all are exported)

	  var Abridged Protocol
		Abridged is abridged transport protocol.
		
		See https://core.telegram.org/mtproto/mtproto-transports#abridged

	  var Full Protocol
		Full is full transport protocol.
		
		See https://core.telegram.org/mtproto/mtproto-transports#full

	  var Intermediate Protocol
		Intermediate is intermediate transport protocol.
		
		See https://core.telegram.org/mtproto/mtproto-transports#intermediate

	  var PaddedIntermediate Protocol
		PaddedIntermediate is padded intermediate transport protocol.
		
		See https://core.telegram.org/mtproto/mtproto-transports#padded-intermediate

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.