package rpc

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

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	    ack.go
	  d doc.go
		Package rpc implements rpc engine.

	    engine.go
	    errors.go
	    external.go
	    options.go
Package-Level Type Names (total 6, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type DropHandler (func)
		DropHandler handles drop rpc requests.

	 type Engine (struct)
		Engine handles RPC requests.

		Fields (total 13, none are exported)
			/* 13 unexporteds ... *//* 13 unexporteds: */
			ack map[int64]chan struct{}
			clock clock.Clock
			closed uint32
			drop DropHandler
			log *zap.Logger
			maxRetries int
			mux sync.Mutex
			reqCancel context.CancelFunc
			reqCtx context.Context
				Canceling pending requests in ForceClose.

			retryInterval time.Duration
			rpc map[int64]func(*bin.Buffer, error) error
			send Send
			wg sync.WaitGroup
		Methods (total 10, in which 6 are exported)
			(*Engine) Close()
				Close gracefully closes the engine.
				All pending requests will be awaited.
				All Do method calls of closed engine will return ErrEngineClosed error.

			(*Engine) Do(ctx context.Context, req Request) error
				Do sends request to server and blocks until response is received, performing
				multiple retries if needed.

			(*Engine) ForceClose()
				ForceClose forcibly closes the engine.
				All pending requests will be canceled.
				All Do method calls of closed engine will return ErrEngineClosed error.

			(*Engine) NotifyAcks(ids []int64)
				NotifyAcks notifies engine about received acknowledgements.

			(*Engine) NotifyError(msgID int64, rpcErr error)
				NotifyError notifies engine about received RPC error.

			(*Engine) NotifyResult(msgID int64, b *bin.Buffer) error
				NotifyResult notifies engine about received RPC response.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*Engine) isClosed() bool
			(*Engine) removeAck(id int64)
			(*Engine) retryUntilAck(ctx context.Context, req Request) (sent bool, err error)
				retryUntilAck resends the request to the server until request is
				acknowledged.
				
				Returns nil if acknowledge was received or error otherwise.

			(*Engine) waitAck(id int64) chan struct{}
		As Outputs Of (at least one exported)
			func New(send Send, cfg Options) *Engine

	 type Options (struct)
		Options of rpc engine.

		Fields (total 5, all are exported)
			Clock clock.Clock
			DropHandler DropHandler
			Logger *zap.Logger
			MaxRetries int
			RetryInterval time.Duration
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*Options) setDefaults()
		As Inputs Of (at least one exported)
			func New(send Send, cfg Options) *Engine

	 type Request (struct)
		Request represents client RPC request.

		Fields (total 4, all are exported)
			Input bin.Encoder
			MsgID int64
			Output bin.Decoder
			SeqNo int32
		As Inputs Of (at least 4, in which 2 are exported)
			func NopDrop(Request) error
			func (*Engine).Do(ctx context.Context, req Request) error
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func (*Engine).retryUntilAck(ctx context.Context, req Request) (sent bool, err error)
			func github.com/gotd/td/internal/mtproto.(*Conn).dropRPC(req Request) error

	 type RetryLimitReachedErr (struct)
		RetryLimitReachedErr means that server does not acknowledge request
		after multiple retries.

		Fields (only one, which is exported)
			Retries int
		Methods (total 2, both are exported)
			(*RetryLimitReachedErr) Error() string
			(*RetryLimitReachedErr) Is(err error) bool
				Is reports whether err is RetryLimitReachedErr.

		Implements (at least one exported)
			*RetryLimitReachedErr : error

	 type Send (func)
		Send is a function that sends requests to the server.

		As Inputs Of (at least one exported)
			func New(send Send, cfg Options) *Engine


Package-Level Functions (total 3, all are exported)

	 func New(send Send, cfg Options) *Engine
		New creates new rpc Engine.

	 func NopDrop(Request) error
		NopDrop does nothing.

	 func NopSend(context.Context, int64, int32, bin.Encoder) error
		NopSend does nothing.


Package-Level Variables (only one, which is exported)

	  var ErrEngineClosed error
		ErrEngineClosed means that engine was closed.

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.