kv

Documentation

Index

• func KeyAccountAccessToken(i int64) string
• func KeyFediActor(a string) string
• func KeyFediHostMeta(d string) string
• func KeyFediNodeInfo(d string) string
• func KeyInstanceOAuth(i int64) string
• func KeyMetricsDeliverError(t time.Time) string
• func KeyMetricsDeliverErrorTotal(t time.Time) string
• func KeyMetricsDeliverSuccess(t time.Time) string
• func KeyMetricsDeliverSuccessTotal(t time.Time) string
• func KeyMetricsReceived(t time.Time) string
• func KeyMetricsReceivedTotal(t time.Time) string
• func KeySession() string
• type EncryptionError
  • func (e *EncryptionError) Error() string
• type Error
  • func NewEncryptionError(msg string) Error
• type KV
• type Metrics

Functions

func KeyAccountAccessToken

func KeyAccountAccessToken(i int64) string

KeyAccountAccessToken returns the kv key which holds a user's access token.

func KeyFediActor

func KeyFediActor(a string) string

KeyFediActor returns the kv key which holds cached actor.

func KeyFediHostMeta

func KeyFediHostMeta(d string) string

KeyFediHostMeta returns the kv key which holds cached host meta.

func KeyFediNodeInfo

func KeyFediNodeInfo(d string) string

KeyFediNodeInfo returns the kv key which holds cached nodeinfo.

func KeyInstanceOAuth

func KeyInstanceOAuth(i int64) string

KeyInstanceOAuth returns the kv key which holds an instance's oauth tokens.

func KeyMetricsDeliverError

func KeyMetricsDeliverError(t time.Time) string

KeyMetricsDeliverError returns the kv key which holds the number of delivery errors to an instance.

func KeyMetricsDeliverErrorTotal

func KeyMetricsDeliverErrorTotal(t time.Time) string

KeyMetricsDeliverErrorTotal returns the kv key which holds the number of delivery errors

func KeyMetricsDeliverSuccess

func KeyMetricsDeliverSuccess(t time.Time) string

KeyMetricsDeliverSuccess returns the kv key which holds the number of delivery successes to an instance.

func KeyMetricsDeliverSuccessTotal

func KeyMetricsDeliverSuccessTotal(t time.Time) string

KeyMetricsDeliverSuccessTotal returns the kv key which holds the number of delivery successes to an instance.

func KeyMetricsReceived

func KeyMetricsReceived(t time.Time) string

KeyMetricsReceived returns the kv key which holds the number of receives from an instance.

func KeyMetricsReceivedTotal

func KeyMetricsReceivedTotal(t time.Time) string

KeyMetricsReceivedTotal returns the kv key which holds the number of receives.

func KeySession

func KeySession() string

KeySession returns the base kv key prefix.

Types

type EncryptionError

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

EncryptionError is returned when a an encryption error occurs.

func (*EncryptionError) Error

func (e *EncryptionError) Error() string

Error returns the error message as a string.

type Error

type Error error

Error represents a database specific error.

var (
	// ErrNil is returned when the kv value is nil.
	ErrNil Error = fmt.Errorf("nil")
)

func NewEncryptionError

func NewEncryptionError(msg string) Error

NewEncryptionError wraps a message in an EncryptionError object.

type KV

type KV interface {
	fedihelper.KV
	Metrics
}

KV represents a key value store.

type Metrics

type Metrics interface {
	IncMetricsDeliverError(ctx context.Context, instanceID int64, timestamp time.Time) Error
	IncMetricsDeliverErrorTotal(ctx context.Context, timestamp time.Time) Error
	IncMetricsDeliverSuccess(ctx context.Context, instanceID int64, timestamp time.Time) Error
	IncMetricsDeliverSuccessTotal(ctx context.Context, timestamp time.Time) Error
	IncMetricsReceived(ctx context.Context, instanceID int64, timestamp time.Time) Error
	IncMetricsReceivedTotal(ctx context.Context, timestamp time.Time) Error

	MGetMetricsDeliverError(ctx context.Context, instanceID int64, timestamps []time.Time) (map[time.Time]int, Error)
	MGetAllMetricsDeliverError(ctx context.Context, timestamps []time.Time) (map[int64]map[time.Time]int, Error)
	MGetMetricsDeliverSuccess(ctx context.Context, instanceID int64, timestamps []time.Time) (map[time.Time]int, Error)
	MGetAllMetricsDeliverSuccess(ctx context.Context, timestamps []time.Time) (map[int64]map[time.Time]int, Error)
	MGetMetricsReceived(ctx context.Context, instanceID int64, timestamps []time.Time) (map[time.Time]int, Error)
	MGetMetricsReceivedTotal(ctx context.Context, timestamps []time.Time) (map[time.Time]int, Error)
	MGetAllMetricsReceived(ctx context.Context, timestamps []time.Time) (map[int64]map[time.Time]int, Error)
}