redis

Documentation

Overview

Package redis contains gotd storage implementations using Redis.

Index

• type Credentials
  • func NewCredentials(client *redis.Client) Credentials
• type PeerStorage
  • func NewPeerStorage(client *redis.Client) *PeerStorage
  • func (s PeerStorage) Add(ctx context.Context, value storage.Peer) error
  • func (s PeerStorage) Assign(ctx context.Context, key string, value storage.Peer) (rerr error)
  • func (s PeerStorage) Find(ctx context.Context, key storage.PeerKey) (storage.Peer, error)
  • func (s PeerStorage) Iterate(ctx context.Context) (storage.PeerIterator, error)
  • func (s PeerStorage) Resolve(ctx context.Context, key string) (storage.Peer, error)
• type SessionStorage
  • func NewSessionStorage(client *redis.Client, key string) SessionStorage

Examples

• Credentials
• SessionStorage

Types

type Credentials

type Credentials struct {
	kv.Credentials
}

Credentials stores user credentials to Redis.

Example

package main

import (
	"context"
	"fmt"
	"os"
	"os/signal"

	redisclient "github.com/go-redis/redis/v8"
	"golang.org/x/xerrors"

	tgauth "github.com/gotd/td/telegram/auth"

	"github.com/gotd/td/telegram"

	"github.com/gotd/contrib/auth"
	"github.com/gotd/contrib/auth/terminal"
	"github.com/gotd/contrib/redis"
)

func redisAuth(ctx context.Context) error {
	redisClient := redisclient.NewClient(&redisclient.Options{})
	cred := redis.NewCredentials(redisClient).
		WithPhoneKey("phone").
		WithPasswordKey("password")

	client, err := telegram.ClientFromEnvironment(telegram.Options{})
	if err != nil {
		return xerrors.Errorf("create client: %w", err)
	}

	return client.Run(ctx, func(ctx context.Context) error {
		return client.Auth().IfNecessary(
			ctx,
			tgauth.NewFlow(auth.Build(cred, terminal.OS()), tgauth.SendCodeOptions{}),
		)
	})
}

func main() {
	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
	defer cancel()

	if err := redisAuth(ctx); err != nil {
		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
		os.Exit(1)
	}
}

func NewCredentials

func NewCredentials(client *redis.Client) Credentials

NewCredentials creates new Credentials.

type PeerStorage

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

PeerStorage is a peer storage based on redis.

func NewPeerStorage

func NewPeerStorage(client *redis.Client) *PeerStorage

NewPeerStorage creates new peer storage using redis.

func (PeerStorage) Add

func (s PeerStorage) Add(ctx context.Context, value storage.Peer) error

Add adds given peer to the storage.

func (PeerStorage) Assign

func (s PeerStorage) Assign(ctx context.Context, key string, value storage.Peer) (rerr error)

Assign adds given peer to the storage and associate it to the given key.

func (PeerStorage) Find

func (s PeerStorage) Find(ctx context.Context, key storage.PeerKey) (storage.Peer, error)

Find finds peer using given key.

func (PeerStorage) Iterate

func (s PeerStorage) Iterate(ctx context.Context) (storage.PeerIterator, error)

Iterate creates and returns new PeerIterator.

func (PeerStorage) Resolve

func (s PeerStorage) Resolve(ctx context.Context, key string) (storage.Peer, error)

Resolve finds peer using associated key.

type SessionStorage

type SessionStorage struct {
	kv.Session
}

SessionStorage is a MTProto session Redis storage.

Example

package main

import (
	"context"
	"fmt"
	"os"
	"os/signal"

	redisclient "github.com/go-redis/redis/v8"
	"golang.org/x/xerrors"

	"github.com/gotd/td/telegram"

	"github.com/gotd/contrib/redis"
)

func redisStorage(ctx context.Context) error {
	redisClient := redisclient.NewClient(&redisclient.Options{})
	storage := redis.NewSessionStorage(redisClient, "session")

	client, err := telegram.ClientFromEnvironment(telegram.Options{
		SessionStorage: storage,
	})
	if err != nil {
		return xerrors.Errorf("create client: %w", err)
	}

	return client.Run(ctx, func(ctx context.Context) error {
		// Force redis to flush DB.
		// It may be necessary to be sure that session will be saved to the disk.
		if err := redisClient.FlushDBAsync(ctx).Err(); err != nil {
			return xerrors.Errorf("flush: %w", err)
		}

		_, err := client.Auth().Bot(ctx, os.Getenv("BOT_TOKEN"))
		return err
	})
}

func main() {
	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
	defer cancel()

	if err := redisStorage(ctx); err != nil {
		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
		os.Exit(1)
	}
}

func NewSessionStorage

func NewSessionStorage(client *redis.Client, key string) SessionStorage

NewSessionStorage creates new SessionStorage.