package pool

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

Dependency Relation
	imports 9 packages, and imported by 2 packages

Involved Source Files

	    options.go
	  d pool.go
		Package pool contains Telegram connections pool.

	    pool_conn.go
	    req_map.go
	    session.go
Package-Level Type Names (total 8, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Conn (interface)
		Conn represents Telegram MTProto connection.

		Methods (total 4, all are exported)
			( Conn) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
			( Conn) Ping(ctx context.Context) error
			( Conn) Ready() <-chan struct{}
			( Conn) Run(ctx context.Context) error
		Implemented By (at least 2, in which 1 is exported)
			*github.com/gotd/td/telegram/internal/manager.Conn
			/* at least one unexported ... *//* at least one unexported: */
			 poolConn
		Implements (at least 2, in which 1 is exported)
			 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 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/gotd/td/telegram.(*Client).createConn(id int64, mode manager.ConnMode, setup manager.SetupCallback) Conn
			func github.com/gotd/td/telegram.(*Client).createPrimaryConn(setup manager.SetupCallback) Conn

	 type DC (struct)
		DC represents connection pool to one data center.

		Fields (total 14, none are exported)
			/* 14 unexporteds ... *//* 14 unexporteds: */
			cancel context.CancelFunc
				// immutable

			closed atomic.Bool
			ctx context.Context
				DC context. Will be canceled by Run on exit.
				// immutable

			free []*poolConn
				Free connections.

			freeReq *reqMap
			grp *tdsync.Supervisor
				Connections supervisor.

			id int
			log *zap.Logger
				Wrappers for external world, like logs or PRNG.
				// immutable

			max int64
				Limit of connections.
				// immutable

			mu sync.Mutex
				DC mutex.

			newConn func() Conn
				Connection constructor.

			nextConn atomic.Int64
				Connection id monotonic counter.

			stuck *tdsync.ResetReady
				Signal connection for cases when all connections are dead, but all requests waiting for
				free connection in 3rd acquire case.

			total int64
				Total connections.

		Methods (total 7, in which 2 are exported)
			(*DC) Close() error
				Close waits while all ongoing requests will be done or until given context is done.
				Then, closes the DC.

			(*DC) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
				Invoke sends MTProto request using one of pool connection.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*DC) acquire(ctx context.Context) (r *poolConn, err error)
			(*DC) createConnection(id int64) *poolConn
			(*DC) dead(r *poolConn, deadErr error)
			(*DC) pop() (r *poolConn, ok bool)
			(*DC) release(r *poolConn)
		Implements (at least 3, all are exported)
			*DC : github.com/gotd/td/telegram.CloseInvoker
			*DC : github.com/gotd/td/tg.Invoker
			*DC : io.Closer
		As Outputs Of (at least 3, in which 1 is exported)
			func NewDC(ctx context.Context, id int, newConn func() Conn, opts DCOptions) *DC
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/gotd/td/telegram.(*Client).createPool(dc int, max int64, creator func() Conn) (*DC, error)
			func github.com/gotd/td/telegram.(*Client).dc(ctx context.Context, dcID int, max int64, dialer mtproto.Dialer) (*DC, error)

	 type DCOptions (struct)
		DCOptions is a Telegram data center connections pool options.

		Fields (total 2, both are exported)
			Logger *zap.Logger
				Logger is instance of zap.Logger. No logs by default.

			MaxOpenConnections int64
				MTProto options for connections.
				Opened connection limit to the DC.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*DCOptions) setDefaults()
		As Inputs Of (at least one exported)
			func NewDC(ctx context.Context, id int, newConn func() Conn, opts DCOptions) *DC

	 type Session (struct)
		Session represents DC session.

		Fields (total 3, all are exported)
			AuthKey crypto.AuthKey
			DC int
			Salt int64
		As Outputs Of (at least 2, both are exported)
			func (*SyncSession).Load() (data Session)
			func (*SyncSession).Options(opts mtproto.Options) (mtproto.Options, Session)
		As Inputs Of (at least 2, both are exported)
			func NewSyncSession(data Session) *SyncSession
			func (*SyncSession).Store(data Session)

	 type SyncSession (struct)
		SyncSession is synchronization helper for Session.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			data Session
			mux sync.RWMutex
		Methods (total 4, all are exported)
			(*SyncSession) Load() (data Session)
				Load gets session and returns it.

			(*SyncSession) Migrate(dc int)
				Migrate changes current DC and its addr, zeroes AuthKey and Salt.

			(*SyncSession) Options(opts mtproto.Options) (mtproto.Options, Session)
				Options fills Key and Salt field of given Options using stored session and returns it.

			(*SyncSession) Store(data Session)
				Store saves given Session.

		As Outputs Of (at least one exported)
			func NewSyncSession(data Session) *SyncSession

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type poolConn (struct)

		Fields (total 5, in which 1 is exported)
			Conn Conn
			/* 4 unexporteds ... *//* 4 unexporteds: */
			dc *DC
				// immutable

			dead *tdsync.Ready
			deleted *atomic.Bool
			id int64
				// immutable

		Methods (total 5, all are exported)
			(*poolConn) Dead() <-chan struct{}
			( poolConn) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
			( poolConn) Ping(ctx context.Context) error
			( poolConn) Ready() <-chan struct{}
			( poolConn) Run(ctx context.Context) error
		Implements (at least 3, in which 2 are exported)
			 poolConn : Conn
			 poolConn : github.com/gotd/td/tg.Invoker
			/* at least one unexported ... *//* at least one unexported: */
			 poolConn : github.com/gotd/td/telegram.clientConn
		As Outputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func (*DC).acquire(ctx context.Context) (r *poolConn, err error)
			func (*DC).createConnection(id int64) *poolConn
			func (*DC).pop() (r *poolConn, ok bool)
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func (*DC).dead(r *poolConn, deadErr error)
			func (*DC).release(r *poolConn)

	 type reqKey int64 (basic type)
	 type reqMap (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			m map[reqKey]chan *poolConn
			mux sync.Mutex
			nextRequest atomic.Int64
		Methods (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*reqMap) delete(key reqKey)
			(*reqMap) request() (key reqKey, ch chan *poolConn)
			(*reqMap) transfer(c *poolConn) bool
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newReqMap() *reqMap


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

	 func NewDC(ctx context.Context, id int, newConn func() Conn, opts DCOptions) *DC
		NewDC creates new uninitialized DC.

	 func NewSyncSession(data Session) *SyncSession
		NewSyncSession creates new SyncSession.

	/* one unexported ... *//* one unexported: */
	 func newReqMap() *reqMap
Package-Level Variables (total 2, in which 1 is exported)

	  var ErrConnDead error
		ErrConnDead means that connection is closed and can't be used anymore.

	/* one unexported ... *//* one unexported: */
	  var errDCIsClosed error

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.