store

type Config struct {
	URL      string        // database URI
	Password string        // database password
	Timeout  time.Duration // database entry timeout (0 == none)
	PoolSize int           // redis connection pool size (0 == the client default)
}

type EntryEnumerator interface {
	// CountEntries returns numbers of servers and clients.
	CountEntries(ctx context.Context) (int64, int64, error)

	// AllEntries returns all clients PKs.
	AllEntries(ctx context.Context) ([]string, error)

	// AllVisorEntries returns all clients PKs.
	AllVisorEntries(ctx context.Context) ([]string, error)

	// AllClientEntries returns all full client entries.
	AllClientEntries(ctx context.Context) ([]*disc.Entry, error)
}

type EntryStore interface {
	// Entry obtains a single dmsg instance entry.
	Entry(ctx context.Context, staticPubKey cipher.PubKey) (*disc.Entry, error)

	// SetEntry set's an entry.
	// This is unsafe and does not check signature.
	SetEntry(ctx context.Context, entry *disc.Entry, timeout time.Duration) error

	// DelEntry delete's an entry.
	DelEntry(ctx context.Context, staticPubKey cipher.PubKey) error
}

type InboxStore interface {
	// SetInbox stores pk's record until ttl passes.
	SetInbox(ctx context.Context, pk cipher.PubKey, record []byte, ttl time.Duration) error
	// Inbox returns pk's record, or disc.ErrKeyNotFound.
	Inbox(ctx context.Context, pk cipher.PubKey) ([]byte, error)
}

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

type ServerLister interface {
	// AvailableServers discovers available dmsg servers.
	AvailableServers(ctx context.Context, maxCount int) ([]*disc.Entry, error)

	// AllServers discovers available dmsg servers.
	AllServers(ctx context.Context) ([]*disc.Entry, error)
}

type Storer interface {
	EntryStore
	ServerLister
	EntryEnumerator
	UptimeTracker
	InboxStore

	// RemoveOldServerEntries check and remove old server entries that left on redis because of unexpected server shutdown
	RemoveOldServerEntries(ctx context.Context) error

	// RemoveStaleClientEntries removes client entries with expired keys from the
	// "clients" set and applies defaultTTL to legacy entries that have no expiration.
	RemoveStaleClientEntries(ctx context.Context, defaultTTL time.Duration) (removed, ttlSet int, err error)
}

type UptimeTracker interface {
	RecordHeartbeat(ctx context.Context, pk cipher.PubKey, version string) error
	GetAllVisorSummaries(ctx context.Context, v2 bool, timeline bool) ([]VisorSummary, error)
	GetDailyTimeline(ctx context.Context, pkHex string, now time.Time) map[string]string
}

type VisorSummary struct {
	PK       cipher.PubKey     `json:"pk"`
	Online   bool              `json:"on"`
	Version  string            `json:"version,omitempty"`
	Daily    map[string]string `json:"daily,omitempty"`
	Timeline map[string]string `json:"timeline,omitempty"`
}