package codec

Import Path
	github.com/gotd/td/internal/proto/codec (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 5 packages

Involved Source Files

	    abridged.go
	    codec.go
	  d doc.go
		Package codec contains MTProto transport encoding implementations.
		
		See https://core.telegram.org/mtproto/mtproto-transports

	    errors.go
	    full.go
	    intermediate.go
	    no_header.go
	    padded_intermediate.go
Package-Level Type Names (total 10, in which 8 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Abridged (struct)
		Abridged is intermediate MTProto transport.
		
		See https://core.telegram.org/mtproto/mtproto-transports#abridged

		Methods (total 5, all are exported)
			( Abridged) ObfuscatedTag() (r [4]byte)
				ObfuscatedTag returns protocol tag for obfuscation.

			( Abridged) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

			( Abridged) ReadHeader(r io.Reader) error
				ReadHeader reads protocol tag.

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

			( Abridged) WriteHeader(w io.Writer) error
				WriteHeader sends protocol tag.

		Implements (at least 3, all are exported)
			 Abridged : Codec
			 Abridged : TaggedCodec
			 Abridged : github.com/gotd/td/transport.Codec

	 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)
			 Abridged
			*Full
			 Intermediate
			 NoHeader
			 PaddedIntermediate
			 TaggedCodec (interface)
			 github.com/gotd/td/transport.Codec (interface)
		Implements (at least one exported)
			 Codec : github.com/gotd/td/transport.Codec
		As Outputs Of (at least one exported)
			func github.com/gotd/td/internal/mtproxy.Secret.ExpectedCodec() (cdc Codec, _ bool)

	 type Full (struct)
		Full is full MTProto transport.
		
		See https://core.telegram.org/mtproto/mtproto-transports#full

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			rSeqNo int64
			wSeqNo int64
		Methods (total 4, all are exported)
			(*Full) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

			(*Full) ReadHeader(r io.Reader) (err error)
				ReadHeader reads protocol tag.

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

			(*Full) WriteHeader(w io.Writer) (err error)
				WriteHeader sends protocol tag.

		Implements (at least 2, both are exported)
			*Full : Codec
			*Full : github.com/gotd/td/transport.Codec

	 type Intermediate (struct)
		Intermediate is intermediate MTProto transport.
		
		See https://core.telegram.org/mtproto/mtproto-transports#intermediate

		Methods (total 5, all are exported)
			( Intermediate) ObfuscatedTag() [4]byte
				ObfuscatedTag returns protocol tag for obfuscation.

			( Intermediate) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

			( Intermediate) ReadHeader(r io.Reader) (err error)
				ReadHeader reads protocol tag.

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

			( Intermediate) WriteHeader(w io.Writer) (err error)
				WriteHeader sends protocol tag.

		Implements (at least 3, all are exported)
			 Intermediate : Codec
			 Intermediate : TaggedCodec
			 Intermediate : github.com/gotd/td/transport.Codec

	 type NoHeader (struct)
		NoHeader wraps codec to skip WriteHeader.

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

			( NoHeader) ReadHeader(io.Reader) error
				ReadHeader implements Codec.

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

			( NoHeader) WriteHeader(io.Writer) error
				WriteHeader implements Codec.

		Implements (at least 2, both are exported)
			 NoHeader : Codec
			 NoHeader : github.com/gotd/td/transport.Codec

	 type PaddedIntermediate (struct)
		PaddedIntermediate is intermediate MTProto transport.
		
		See https://core.telegram.org/mtproto/mtproto-transports#padded-intermediate

		Methods (total 5, all are exported)
			( PaddedIntermediate) ObfuscatedTag() [4]byte
				ObfuscatedTag returns protocol tag for obfuscation.

			( PaddedIntermediate) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

			( PaddedIntermediate) ReadHeader(r io.Reader) error
				ReadHeader reads protocol tag.

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

			( PaddedIntermediate) WriteHeader(w io.Writer) error
				WriteHeader sends protocol tag.

		Implements (at least 3, all are exported)
			 PaddedIntermediate : Codec
			 PaddedIntermediate : TaggedCodec
			 PaddedIntermediate : github.com/gotd/td/transport.Codec

	 type ProtocolErr (struct)
		ProtocolErr represents protocol level error.

		Fields (only one, which is exported)
			Code int32
		Methods (only one, which is exported)
			( ProtocolErr) Error() string
		Implements (at least one exported)
			 ProtocolErr : error

	 type TaggedCodec (interface)
		TaggedCodec is codec with protocol tag.

		Methods (total 5, all are exported)
			( TaggedCodec) ObfuscatedTag() [4]byte
				ObfuscatedTag returns protocol tag for obfuscation.

			( TaggedCodec) Read(r io.Reader, b *bin.Buffer) error
				Read fills buffer with received message.

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

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

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

		Implemented By (at least 3, all are exported)
			 Abridged
			 Intermediate
			 PaddedIntermediate
		Implements (at least 2, both are exported)
			 TaggedCodec : Codec
			 TaggedCodec : github.com/gotd/td/transport.Codec

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type alignedPayloadExpectedErr (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			expected int
		Methods (total 2, both are exported)
			( alignedPayloadExpectedErr) Error() string
			( alignedPayloadExpectedErr) Is(err error) bool
		Implements (at least one exported)
			 alignedPayloadExpectedErr : error

	 type invalidMsgLenErr (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			n int
		Methods (total 2, both are exported)
			( invalidMsgLenErr) Error() string
			( invalidMsgLenErr) Is(err error) bool
		Implements (at least one exported)
			 invalidMsgLenErr : error


Package-Level Functions (total 12, none are exported)

	/* 12 unexporteds ... *//* 12 unexporteds: */
	 func checkAlign(b *bin.Buffer, n int) error
	 func checkOutgoingMessage(b *bin.Buffer) error
	 func checkProtocolError(b *bin.Buffer) error
	 func readAbridged(r io.Reader, b *bin.Buffer) error
	 func readFull(r io.Reader, seqNo int, b *bin.Buffer) error
	 func readIntermediate(r io.Reader, b *bin.Buffer, padding bool) error
		readIntermediate reads payload from r to b.

	 func readLen(r io.Reader, b *bin.Buffer) (int, error)
		readLen reads 32-bit integer and validates it as message length.

	 func readPaddedIntermediate(r io.Reader, b *bin.Buffer) error
	 func writeAbridged(w io.Writer, b *bin.Buffer) error
	 func writeFull(w io.Writer, seqNo int, b *bin.Buffer) error
	 func writeIntermediate(w io.Writer, b *bin.Buffer) error
		writeIntermediate encodes b as payload to w.

	 func writePaddedIntermediate(randSource io.Reader, w io.Writer, b *bin.Buffer) error
Package-Level Variables (total 6, in which 4 are exported)

	  var AbridgedClientStart [1]byte
		AbridgedClientStart is starting bytes sent by client in Abridged mode.
		
		Note that server does not respond with it.

	  var ErrProtocolHeaderMismatch error
		ErrProtocolHeaderMismatch means that received protocol header
		is mismatched with expected.

	  var IntermediateClientStart [4]byte
		IntermediateClientStart is starting bytes sent by client in Intermediate mode.
		
		Note that server does not respond with it.

	  var PaddedIntermediateClientStart [4]byte
		PaddedIntermediateClientStart is starting bytes sent by client in Padded intermediate mode.
		
		Note that server does not respond with it.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var errCRCMismatch error
	  var errSeqNoMismatch error
Package-Level Constants (total 4, in which 3 are exported)

	const CodeAuthKeyNotFound = 404
		CodeAuthKeyNotFound means that specified auth key ID cannot be found by the DC.
		Also, may be returned during key exchange.

	const CodeTransportFlood = 429
		CodeTransportFlood means that too many transport connections are
		established to the same IP in a too short lapse of time, or if any
		of the container/service message limits are reached.

	const CodeWrongDC = 444
		CodeWrongDC means that current DC is wrong.
		Usually returned by server when key exchange sends wrong DC ID.

	/* one unexported ... *//* one unexported: */
	const maxMessageSize = 16777216 // 16 MB
		Can be bigger that 1mb.
		
		See https://github.com/gotd/td/issues/412
		
		See https://github.com/tdlib/td/blob/550ccc8d9bbbe9cff1dc618aef5764d2cbd2cd91/td/mtproto/TcpTransport.cpp#L53

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.