backend

Documentation

Overview

Package backend provides a generic interface for manipulating a BitTorrent tracker's consistent backend data store (usually for a web application).

Index

• func Register(name string, driver Driver)
• type Conn
  • func Open(cfg *config.DriverConfig) (Conn, error)
• type Driver

Functions

func Register

func Register(name string, driver Driver)

Register makes a database driver available by the provided name. If Register is called twice with the same name or if driver is nil, it panics.

Types

type Conn

type Conn interface {
	// Close terminates connections to the database(s) and gracefully shuts
	// down the driver
	Close() error

	// RecordAnnounce is called once per announce, and is passed the delta in
	// statistics for the client peer since its last announce.
	RecordAnnounce(delta *models.AnnounceDelta) error

	// LoadTorrents fetches and returns the specified torrents.
	LoadTorrents(ids []uint64) ([]*models.Torrent, error)

	// LoadAllTorrents fetches and returns all torrents.
	LoadAllTorrents() ([]*models.Torrent, error)

	// LoadUsers fetches and returns the specified users.
	LoadUsers(ids []uint64) ([]*models.User, error)

	// LoadAllUsers fetches and returns all users.
	LoadAllUsers(ids []uint64) ([]*models.User, error)
}

Conn represents a connection to the data store.

func Open

func Open(cfg *config.DriverConfig) (Conn, error)

Open creates a connection specified by a configuration.

type Driver

type Driver interface {
	New(*config.DriverConfig) (Conn, error)
}

Driver represents an interface to a long-running connection with a consistent data store.