invokers

Documentation

Overview

Package invokers contains some middlewares and helpers to work with RPC invokers.

Index

• Constants
• type Object
• type RateLimiter
  • func NewRateLimiter(invoker tg.Invoker, lim *rate.Limiter) *RateLimiter
  • func (l *RateLimiter) InvokeRaw(ctx context.Context, input bin.Encoder, output bin.Decoder) error
  • func (l *RateLimiter) WithClock(c clock.Clock) *RateLimiter
• type Waiter
  • func NewWaiter(prev tg.Invoker) *Waiter
  • func (w *Waiter) InvokeRaw(ctx context.Context, input bin.Encoder, output bin.Decoder) error
  • func (w *Waiter) Run(ctx context.Context) error
  • func (w *Waiter) WithClock(c clock.Clock) *Waiter
  • func (w *Waiter) WithRetryLimit(retryLimit int) *Waiter
  • func (w *Waiter) WithTick(tick time.Duration) *Waiter
  • func (w *Waiter) WithWaitLimit(waitLimit int) *Waiter

Examples

• RateLimiter

Constants

const ErrFloodWait = "FLOOD_WAIT"

ErrFloodWait is error type of "FLOOD_WAIT" error.

Types

type Object

type Object interface {
	TypeID() uint32
}

Object is a abstraction for Telegram API object with TypeID.

type RateLimiter

type RateLimiter struct {
	// contains filtered or unexported fields
}

RateLimiter is a tg.Invoker that throttles RPC calls on underlying invoker.

Example

package main

import (
	"time"

	"golang.org/x/time/rate"

	"github.com/gotd/td/telegram/invokers"
	"github.com/gotd/td/tg"
)

func main() {
	var invoker tg.Invoker // e.g. *telegram.Client

	limiter := invokers.NewRateLimiter(invoker,
		rate.NewLimiter(rate.Every(100*time.Millisecond), 1),
	)

	tg.NewClient(limiter)
}

func NewRateLimiter

func NewRateLimiter(invoker tg.Invoker, lim *rate.Limiter) *RateLimiter

NewRateLimiter returns a new invoker rate limiter using lim.

func (*RateLimiter) InvokeRaw

func (l *RateLimiter) InvokeRaw(ctx context.Context, input bin.Encoder, output bin.Decoder) error

InvokeRaw implements tg.Invoker.

func (*RateLimiter) WithClock

func (l *RateLimiter) WithClock(c clock.Clock) *RateLimiter

WithClock sets clock to use. Default is to use system clock.

type Waiter

type Waiter struct {
	// contains filtered or unexported fields
}

Waiter is a invoker middleware to handle FLOOD_WAIT errors from Telegram.

func NewWaiter

func NewWaiter(prev tg.Invoker) *Waiter

NewWaiter creates new Waiter invoker middleware.

func (*Waiter) InvokeRaw

func (w *Waiter) InvokeRaw(ctx context.Context, input bin.Encoder, output bin.Decoder) error

InvokeRaw implements tg.Invoker.

func (*Waiter) Run

func (w *Waiter) Run(ctx context.Context) error

Run runs send loop.

func (*Waiter) WithClock

func (w *Waiter) WithClock(c clock.Clock) *Waiter

WithClock sets clock to use.

func (*Waiter) WithRetryLimit

func (w *Waiter) WithRetryLimit(retryLimit int) *Waiter

WithRetryLimit sets retry limit to use.

func (*Waiter) WithTick

func (w *Waiter) WithTick(tick time.Duration) *Waiter

WithTick sets gather tick for Waiter.

func (*Waiter) WithWaitLimit

func (w *Waiter) WithWaitLimit(waitLimit int) *Waiter

WithWaitLimit sets wait limit to use.