package proto

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

Dependency Relation
	imports 10 packages, and imported by 3 packages

Involved Source Files

	    container.go
	  d doc.go
		Package proto implements MTProto 2.0 primitives.
		
		See https://core.telegram.org/mtproto/description for reference.

	    gzip.go
	    message_id.go
	    registry.go
	    rpc_result.go
	    unencrypted_message.go
Package-Level Type Names (total 12, in which 10 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type DecompressionBombErr (struct)
		DecompressionBombErr means that GZIP decode detected decompression bomb
		which decompressed payload is significantly higher than initial compressed
		size and stopped decompression to prevent OOM.

		Fields (total 2, both are exported)
			Compressed int
			Decompressed int
		Methods (only one, which is exported)
			(*DecompressionBombErr) Error() string
		Implements (at least one exported)
			*DecompressionBombErr : error

	 type GZIP (struct)
		GZIP represents a Packed Object.
		
		Used to replace any other object (or rather, a serialization thereof)
		with its archived (gzipped) representation.

		Fields (only one, which is exported)
			Data []byte
		Methods (total 2, both are exported)
			(*GZIP) Decode(b *bin.Buffer) (rErr error)
				Decode implements bin.Decoder.

			( GZIP) Encode(b *bin.Buffer) (rErr error)
				Encode implements bin.Encoder.

		Implements (at least 3, all are exported)
			*GZIP : github.com/gotd/td/bin.Decoder
			 GZIP : github.com/gotd/td/bin.Encoder
			*GZIP : github.com/gotd/td/bin.Object

	 type Message (struct)
		Message is element of MessageContainer.

		Fields (total 4, all are exported)
			Body []byte
			Bytes int
			ID int64
			SeqNo int
		Methods (total 2, both are exported)
			(*Message) Decode(b *bin.Buffer) error
				Decode implements bin.Decoder.

			(*Message) Encode(b *bin.Buffer) error
				Encode implements bin.Encoder.

		Implements (at least 3, all are exported)
			*Message : github.com/gotd/td/bin.Decoder
			*Message : github.com/gotd/td/bin.Encoder
			*Message : github.com/gotd/td/bin.Object
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/internal/mtproto.(*Conn).processContainerMessage(msgID int64, msg Message) error

	 type MessageContainer (struct)
		MessageContainer contains slice of messages.

		Fields (only one, which is exported)
			Messages []Message
		Methods (total 2, both are exported)
			(*MessageContainer) Decode(b *bin.Buffer) error
				Decode implements bin.Decoder.

			(*MessageContainer) Encode(b *bin.Buffer) error
				Encode implements bin.Decoder.

		Implements (at least 3, all are exported)
			*MessageContainer : github.com/gotd/td/bin.Decoder
			*MessageContainer : github.com/gotd/td/bin.Encoder
			*MessageContainer : github.com/gotd/td/bin.Object

	 type MessageID int64 (basic type)
		MessageID represents 64-bit message id.

		Methods (total 3, all are exported)
			( MessageID) String() string
			( MessageID) Time() time.Time
				Time returns approximate time when MessageID were generated.

			( MessageID) Type() MessageType
				Type returns message type.

		Implements (at least 3, in which 1 is exported)
			 MessageID : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 MessageID : context.stringer
			 MessageID : runtime.stringer
		As Outputs Of (at least 2, both are exported)
			func NewMessageID(now time.Time, typ MessageType) MessageID
			func NewMessageIDNano(nano int64, typ MessageType) MessageID

	 type MessageIDBuf (struct)
		MessageIDBuf stores last N message ids and is used in replay attack mitigation.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			buf []int64
			mux sync.Mutex
		Methods (only one, which is exported)
			(*MessageIDBuf) Consume(newID int64) bool
				Consume returns false if message should be discarded.

		Implements (at least one exported)
			*MessageIDBuf : github.com/gotd/td/internal/mtproto.MessageBuf
		As Outputs Of (at least one exported)
			func NewMessageIDBuf(n int) *MessageIDBuf

	 type MessageIDGen (struct)
		MessageIDGen is message id generator that provides collision prevention.
		
		The main reason of such structure is that now() can return same time during
		multiple calls and that leads to duplicate message id.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			mux sync.Mutex
			nano int64
			now func() time.Time
		Methods (only one, which is exported)
			(*MessageIDGen) New(t MessageType) int64
				New generates new message id for provided type, protecting from collisions
				that are caused by low system time resolution.

		Implements (at least one exported)
			*MessageIDGen : github.com/gotd/td/internal/mtproto.MessageIDSource
		As Outputs Of (at least one exported)
			func NewMessageIDGen(now func() time.Time) *MessageIDGen

	 type MessageType byte (basic type)
		MessageType is type of message determined by message id.
		
		A message is rejected over 300 seconds after it is created or
		30 seconds before it is created (this is needed to protect from replay attacks).
		
		The identifier of a message container must be strictly greater than those of
		its nested messages.

		Methods (only one, which is exported)
			( MessageType) String() string
		Implements (at least 3, in which 1 is exported)
			 MessageType : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 MessageType : context.stringer
			 MessageType : runtime.stringer
		As Outputs Of (at least one exported)
			func MessageID.Type() MessageType
		As Inputs Of (at least 5, in which 4 are exported)
			func NewMessageID(now time.Time, typ MessageType) MessageID
			func NewMessageIDNano(nano int64, typ MessageType) MessageID
			func (*MessageIDGen).New(t MessageType) int64
			func github.com/gotd/td/internal/mtproto.MessageIDSource.New(t MessageType) int64
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/internal/exchange.Exchanger.unencryptedWriter(input, output MessageType) exchange.unencryptedWriter
		As Types Of (total 4, all are exported)
			const MessageFromClient
			const MessageFromServer
			const MessageServerResponse
			const MessageUnknown

	 type Result (struct)
		Result is rpc_result#f35c6d01.

		Fields (total 2, both are exported)
			RequestMessageID int64
			Result []byte
		Methods (total 2, both are exported)
			(*Result) Decode(b *bin.Buffer) error
				Decode implements bin.Decoder.

			(*Result) Encode(b *bin.Buffer) error
				Encode implements bin.Encoder.

		Implements (at least 3, all are exported)
			*Result : github.com/gotd/td/bin.Decoder
			*Result : github.com/gotd/td/bin.Encoder
			*Result : github.com/gotd/td/bin.Object

	 type UnencryptedMessage (struct)
		UnencryptedMessage is plaintext message.

		Fields (total 2, both are exported)
			MessageData []byte
			MessageID int64
		Methods (total 2, both are exported)
			(*UnencryptedMessage) Decode(b *bin.Buffer) error
				Decode implements bin.Decoder.

			( UnencryptedMessage) Encode(b *bin.Buffer) error
				Encode implements bin.Encoder.

		Implements (at least 3, all are exported)
			*UnencryptedMessage : github.com/gotd/td/bin.Decoder
			 UnencryptedMessage : github.com/gotd/td/bin.Encoder
			*UnencryptedMessage : github.com/gotd/td/bin.Object

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

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			read int64
			reader io.Reader
		Methods (total 2, both are exported)
			(*countReader) Read(p []byte) (n int, err error)
			(*countReader) Total() int64
		Implements (at least one exported)
			*countReader : io.Reader

	 type gzipPool (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			readers sync.Pool
			writers sync.Pool
		Methods (total 4, all are exported)
			(*gzipPool) GetReader(r io.Reader) (*gzip.Reader, error)
			(*gzipPool) GetWriter(w io.Writer) *gzip.Writer
			(*gzipPool) PutReader(w *gzip.Reader)
			(*gzipPool) PutWriter(w *gzip.Writer)
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newGzipPool() *gzipPool
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var gzipRWPool *gzipPool


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

	 func NewMessageID(now time.Time, typ MessageType) MessageID
		NewMessageID returns new message id for provided time and type.

	 func NewMessageIDBuf(n int) *MessageIDBuf
		NewMessageIDBuf initializes new message id buffer for last N stored values.

	 func NewMessageIDGen(now func() time.Time) *MessageIDGen
		NewMessageIDGen creates new message id generator.
		
		Current time will be provided by now() function.
		
		This generator compensates time resolution problem removing
		probability of id collision.
		
		Such problem can be observed for relatively high RPS, sequential calls to
		time.Now() will return same time which leads to equal ids.

	 func NewMessageIDNano(nano int64, typ MessageType) MessageID
		NewMessageIDNano returns new message id for provided current unix
		nanoseconds and type.

	 func TypesMap() map[uint32]string
		TypesMap returns mapping from type ids to TL type names.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func newGzipPool() *gzipPool
	 func newMessageID(nowNano int64, yield int) int64
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var gzipBufPool sync.Pool
	  var gzipRWPool *gzipPool
Package-Level Constants (total 11, in which 7 are exported)

	const GZIPTypeID = 812830625
		GZIPTypeID is TL type id of GZIP.

	const MessageContainerTypeID = 1945237724
		MessageContainerTypeID is TL type id of MessageContainer.

	const MessageFromClient MessageType = 1
		MessageFromClient is client message identifiers.

	const MessageFromServer MessageType = 3
		MessageFromServer is a message from the server.

	const MessageServerResponse MessageType = 2
		MessageServerResponse is a response to a client message.

	const MessageUnknown MessageType = 0
		MessageUnknown reports that message id has unknown time and probably
		should be ignored.

	const ResultTypeID = 4082920705
		ResultTypeID is TL type id of Result.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	const messageIDModulo = 4
	const yieldClient = 0
	const yieldFromServer = 3
	const yieldServerResponse = 1

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.