package manager

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

Dependency Relation
	imports 17 packages, and imported by one package

Involved Source Files

	    conn.go
	    connmode_string.go
	    create.go
	    device.go
	  d doc.go
		Package manager contains connection management utilities.

	    handler.go
	    sync.go
Package-Level Type Names (total 10, in which 8 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AtomicConfig (struct)
		AtomicConfig is atomic tg.Config.

		Fields (total 2, in which 1 is exported)
			Value atomic.Value
			/* one unexported ... *//* one unexported: */
			Value.v any
		Methods (total 4, all are exported)
			(*AtomicConfig) CompareAndSwap(old, new any) (swapped bool)
				CompareAndSwap executes the compare-and-swap operation for the Value.
				
				All calls to CompareAndSwap for a given Value must use values of the same
				concrete type. CompareAndSwap of an inconsistent type panics, as does
				CompareAndSwap(old, nil).

			(*AtomicConfig) Load() tg.Config
				Load loads atomically config and returns it.

			(*AtomicConfig) Store(cfg tg.Config)
				Store saves given config atomically.

			(*AtomicConfig) Swap(new any) (old any)
				Swap stores new into Value and returns the previous value. It returns nil if
				the Value is empty.
				
				All calls to Swap for a given Value must use values of the same concrete
				type. Swap of an inconsistent type panics, as does Swap(nil).

		As Outputs Of (at least one exported)
			func NewAtomicConfig(cfg tg.Config) *AtomicConfig

	 type Conn (struct)
		Conn is a Telegram client connection.

		Fields (total 16, none are exported)
			/* 16 unexporteds ... *//* 16 unexporteds: */
			appID int
				InitConnection parameters.
				// immutable

			cfg tg.Config
				State fields.

			clock clock.Clock
				Wrappers for external world, like logs or PRNG.
				Should be immutable.
				// immutable

			connBackoff func(ctx context.Context) backoff.BackOff
				// immutable

			dead *tdsync.Ready
				// immutable

			device DeviceConfig
				// immutable

			gotConfig *tdsync.Ready
				// immutable

			handler Handler
				Handler passed by client.
				// immutable

			latest time.Time
			log *zap.Logger
				// immutable

			mode ConnMode
				Connection parameters.
				// immutable

			mux sync.Mutex
			ongoing int
			proto protoConn
				MTProto connection.
				// immutable

			sessionInit *tdsync.Ready
				// immutable

			setup SetupCallback
				setup is callback which called after initConnection, but before ready signaling.
				This is necessary to transfer auth from previous connection to another DC.
				// nilable

		Methods (total 10, in which 6 are exported)
			(*Conn) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
				Invoke implements Invoker.

			(*Conn) OnMessage(b *bin.Buffer) error
				OnMessage implements mtproto.Handler.

			(*Conn) OnSession(session mtproto.Session) error
				OnSession implements mtproto.Handler.

			(*Conn) Ping(ctx context.Context) error
				Ping calls ping for underlying protocol connection.

			(*Conn) Ready() <-chan struct{}
				Ready returns channel to determine connection readiness.
				Useful for pooling.

			(*Conn) Run(ctx context.Context) (err error)
				Run initialize connection.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*Conn) init(ctx context.Context) error
			(*Conn) trackInvoke() func()
			(*Conn) waitSession(ctx context.Context) error
			(*Conn) wrapRequest(req bin.Object) bin.Object
		Implements (at least 4, in which 3 are exported)
			*Conn : github.com/gotd/td/internal/mtproto.Handler
			*Conn : github.com/gotd/td/internal/pool.Conn
			*Conn : github.com/gotd/td/tg.Invoker
			/* at least one unexported ... *//* at least one unexported: */
			*Conn : github.com/gotd/td/telegram.clientConn
		As Outputs Of (at least one exported)
			func CreateConn(create mtproto.Dialer, mode ConnMode, appID int, opts mtproto.Options, connOpts ConnOptions) *Conn

	 type ConnMode byte (basic type)
		ConnMode represents connection mode.

		Methods (only one, which is exported)
			( ConnMode) String() string
		Implements (at least 3, in which 1 is exported)
			 ConnMode : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 ConnMode : context.stringer
			 ConnMode : runtime.stringer
		As Inputs Of (at least 2, in which 1 is exported)
			func CreateConn(create mtproto.Dialer, mode ConnMode, appID int, opts mtproto.Options, connOpts ConnOptions) *Conn
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/telegram.(*Client).createConn(id int64, mode ConnMode, setup SetupCallback) pool.Conn
		As Types Of (total 3, all are exported)
			const ConnModeCDN
			const ConnModeData
			const ConnModeUpdates

	 type ConnOptions (struct)
		ConnOptions is a Telegram client connection options.

		Fields (total 6, all are exported)
			Backoff func(ctx context.Context) backoff.BackOff
			DC int
			Device DeviceConfig
			Handler Handler
			Setup SetupCallback
			Test bool
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*ConnOptions) setDefaults(connClock clock.Clock)
				setDefaults sets default values.

		As Inputs Of (at least one exported)
			func CreateConn(create mtproto.Dialer, mode ConnMode, appID int, opts mtproto.Options, connOpts ConnOptions) *Conn

	 type DeviceConfig (struct)
		DeviceConfig is config which send when Telegram connection session created.

		Fields (total 8, all are exported)
			AppVersion string
				Application version.

			DeviceModel string
				Device model.

			LangCode string
				Code for the language used on the client, ISO 639-1 standard.

			LangPack string
				Language pack to use.

			Params tg.JSONValueClass
				Additional initConnection parameters. For now, only the tz_offset field is supported,
				for specifying timezone offset in seconds.

			Proxy tg.InputClientProxy
				Info about an MTProto proxy.

			SystemLangCode string
				Code for the language used on the device's OS, ISO 639-1 standard.

			SystemVersion string
				Operating system version.

		Methods (only one, which is exported)
			(*DeviceConfig) SetDefaults()
				SetDefaults sets default values.


	 type Handler (interface)
		Handler abstracts updates and session handler.

		Methods (total 2, both are exported)
			( Handler) OnMessage(b *bin.Buffer) error
			( Handler) OnSession(cfg tg.Config, s mtproto.Session) error
		Implemented By (at least 2, in which 1 is exported)
			 NoopHandler
			/* at least one unexported ... *//* at least one unexported: */
			 github.com/gotd/td/telegram.clientHandler
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/telegram.(*Client).asHandler() Handler

	 type NoopHandler (struct)
		NoopHandler is a noop handler.

		Methods (total 2, both are exported)
			( NoopHandler) OnMessage(b *bin.Buffer) error
				OnMessage implements Handler

			( NoopHandler) OnSession(cfg tg.Config, s mtproto.Session) error
				OnSession implements Handler.

		Implements (at least one exported)
			 NoopHandler : Handler

	 type SetupCallback = (func)
		SetupCallback is an optional setup connection callback.

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

		Fields (only one, which is exported)
			Encoder bin.Encoder
		Methods (total 2, both are exported)
			( noopDecoder) Decode(b *bin.Buffer) error
			( noopDecoder) Encode(b *bin.Buffer) error
		Implements (at least 3, all are exported)
			 noopDecoder : github.com/gotd/td/bin.Decoder
			 noopDecoder : github.com/gotd/td/bin.Encoder
			 noopDecoder : github.com/gotd/td/bin.Object

	 type protoConn (interface)

		Methods (total 3, all are exported)
			( protoConn) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
			( protoConn) Ping(ctx context.Context) error
			( protoConn) Run(ctx context.Context, f func(ctx context.Context) error) error
		Implemented By (at least 2, both are exported)
			*github.com/gotd/td/telegram.Client
			*github.com/gotd/td/internal/mtproto.Conn
		Implements (at least one exported)
			 protoConn : github.com/gotd/td/tg.Invoker


Package-Level Functions (total 3, in which 2 are exported)

	 func CreateConn(create mtproto.Dialer, mode ConnMode, appID int, opts mtproto.Options, connOpts ConnOptions) *Conn
		CreateConn creates new connection.

	 func NewAtomicConfig(cfg tg.Config) *AtomicConfig
		NewAtomicConfig creates new AtomicConfig.

	/* one unexported ... *//* one unexported: */
	 func defaultBackoff(c clock.Clock) func(ctx context.Context) backoff.BackOff
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var _ConnMode_index [4]uint8
Package-Level Constants (total 4, in which 3 are exported)

	const ConnModeCDN ConnMode = 2
		ConnModeCDN is CDN connection mode.

	const ConnModeData ConnMode = 1
		ConnModeData is data connection mode.

	const ConnModeUpdates ConnMode = 0
		ConnModeUpdates is update connection mode.

	/* one unexported ... *//* one unexported: */
	const _ConnMode_name = "ConnModeUpdatesConnModeDataConnModeCDN"

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.