redis

Documentation

Index

• Constants
• func StartPingingRedis(ctx context.Context, interval time.Duration, client redis.Cmdable, ...)
• func VerifyConnection(ctx context.Context, client redis.Cmdable, timeout time.Duration) error
• type Accounts
  • func (r *Accounts) Create(ctx context.Context, username string) (service.Account, error)
  • func (r *Accounts) Find(ctx context.Context, username string) (service.Account, error)
  • func (r *Accounts) HealthCheck() service.HealthCheck
  • func (r *Accounts) Revoke(ctx context.Context, shareCode service.ShareCode) error
  • func (r *Accounts) Share(ctx context.Context, account service.Account) (service.ShareCode, error)
  • func (r *Accounts) Shared(ctx context.Context, shareCode service.ShareCode) (service.Account, error)
• type ClientMutator
• type ClientMutators
• type ClientProvider
• type Clients
  • func NewClientsWithRegularPing(ctx context.Context, config *config.Config, provider ClientProvider, ...) (Clients, error)
• type Devices
  • func (r *Devices) AddDevice(ctx context.Context, account service.Account, id service.DeviceID, ...) (service.Device, error)
  • func (r *Devices) DeleteDevice(ctx context.Context, account service.Account, id service.DeviceID) error
  • func (r *Devices) GetDevice(ctx context.Context, account service.Account, id service.DeviceID) (service.Device, error)
  • func (r *Devices) GetDevices(ctx context.Context, account service.Account) (map[service.DeviceID]service.Device, error)
  • func (r *Devices) HealthCheck() service.HealthCheck
• type MetadataProvider
  • func (r *MetadataProvider) Get(ctx context.Context, id service.MetadataID) (service.Metadata, error)
  • func (r *MetadataProvider) HealthCheck() service.HealthCheck
  • func (r *MetadataProvider) Set(ctx context.Context, meta service.Metadata) error
• type Module
  • func ModuleFromBytes(data []byte) *Module
  • func ModuleFromReader(data io.Reader, size int) *Module
  • func (r Module) Raw() io.Reader
  • func (r Module) Size() int
• type Modules
  • func (r *Modules) Delete(ctx context.Context, key string) error
  • func (r *Modules) DeleteByPattern(ctx context.Context, pattern string) error
  • func (r *Modules) Get(ctx context.Context, name string) (service.Module, error)
  • func (r *Modules) HealthCheck() service.HealthCheck
  • func (r *Modules) Set(ctx context.Context, name string, module service.Module) error

Constants

const (
	AccountKeySpace = "octi:accounts"
	ShareKeySpace   = "octi:accounts:share"
)

const (
	EnvRedisAddr           = "REDIS_ADDR"
	EnvRedisUsername       = "REDIS_USERNAME"
	EnvRedisPassword       = "REDIS_PASSWORD"
	DefaultIntervalSeconds = 5
	DefaultTimeoutSeconds  = 5
	NoExpiry               = time.Duration(-1)
)

const DeviceKeySpace = "octi:devices"

const MetadataKeySpace = "octi:metadata"

Functions

func StartPingingRedis

func StartPingingRedis(
	ctx context.Context,
	interval time.Duration,
	client redis.Cmdable,
	logger *zerolog.Logger,
)

func VerifyConnection

func VerifyConnection(ctx context.Context, client redis.Cmdable, timeout time.Duration) error

Types

type Accounts

type Accounts struct {
	Client redis.Cmdable
}

func (*Accounts) Create

func (r *Accounts) Create(ctx context.Context, username string) (service.Account, error)

func (*Accounts) Find

func (r *Accounts) Find(ctx context.Context, username string) (service.Account, error)

func (*Accounts) HealthCheck

func (r *Accounts) HealthCheck() service.HealthCheck

func (*Accounts) Revoke

func (r *Accounts) Revoke(ctx context.Context, shareCode service.ShareCode) error

func (*Accounts) Share

func (r *Accounts) Share(ctx context.Context, account service.Account) (service.ShareCode, error)

func (*Accounts) Shared

func (r *Accounts) Shared(ctx context.Context, shareCode service.ShareCode) (service.Account, error)

type ClientMutator

type ClientMutator func(client goredis.UniversalClient) goredis.UniversalClient

type ClientMutators

type ClientMutators map[string]ClientMutator

type ClientProvider

type ClientProvider func(config *config.Config) goredis.UniversalClient

type Clients

type Clients map[string]goredis.Cmdable

func NewClientsWithRegularPing

func NewClientsWithRegularPing(
	ctx context.Context,
	config *config.Config,
	provider ClientProvider,
	mutators ClientMutators,
) (Clients, error)

type Devices

type Devices struct {
	Client redis.Cmdable
}

func (*Devices) AddDevice

func (r *Devices) AddDevice(
	ctx context.Context, account service.Account, id service.DeviceID, password string,
) (service.Device, error)

func (*Devices) DeleteDevice

func (r *Devices) DeleteDevice(
	ctx context.Context,
	account service.Account,
	id service.DeviceID,
) error

func (*Devices) GetDevice

func (r *Devices) GetDevice(ctx context.Context, account service.Account, id service.DeviceID) (service.Device, error)

func (*Devices) GetDevices

func (r *Devices) GetDevices(
	ctx context.Context,
	account service.Account,
) (map[service.DeviceID]service.Device, error)

func (*Devices) HealthCheck

func (r *Devices) HealthCheck() service.HealthCheck

type MetadataProvider

type MetadataProvider struct {
	Client redis.Cmdable
}

func (*MetadataProvider) Get

func (r *MetadataProvider) Get(ctx context.Context, id service.MetadataID) (service.Metadata, error)

func (*MetadataProvider) HealthCheck

func (r *MetadataProvider) HealthCheck() service.HealthCheck

func (*MetadataProvider) Set

func (r *MetadataProvider) Set(ctx context.Context, meta service.Metadata) error

type Module

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

func ModuleFromBytes

func ModuleFromBytes(data []byte) *Module

func ModuleFromReader

func ModuleFromReader(data io.Reader, size int) *Module

func (Module) Raw

func (r Module) Raw() io.Reader

func (Module) Size

func (r Module) Size() int

type Modules

type Modules struct {
	Client     redis.Cmdable
	Expiration time.Duration
}

func (*Modules) Delete

func (r *Modules) Delete(ctx context.Context, key string) error

func (*Modules) DeleteByPattern

func (r *Modules) DeleteByPattern(ctx context.Context, pattern string) error

func (*Modules) Get

func (r *Modules) Get(ctx context.Context, name string) (service.Module, error)

func (*Modules) HealthCheck

func (r *Modules) HealthCheck() service.HealthCheck

func (*Modules) Set

func (r *Modules) Set(ctx context.Context, name string, module service.Module) error