store

Documentation

Index

• Variables
• func New(c Config) *lockingStore
• func NewMemoryBackend() *memoryBackend
• type Backend
• type Binder
• type CompareResult
• type Config
• type Gateway
• type GatewayRecord
• type Marshaler
• type ReadStore
• type Route
• type RouteRecord
• type StatusUpdater
• type Store
• type WriteStore

Variables

var (
	ErrNotFound = errors.New("not found")
)

Functions

func New

func New(c Config) *lockingStore

func NewMemoryBackend

func NewMemoryBackend() *memoryBackend

Types

type Backend

type Backend interface {
	GetGateway(ctx context.Context, id core.GatewayID) ([]byte, error)
	ListGateways(ctx context.Context) ([][]byte, error)
	DeleteGateway(ctx context.Context, id core.GatewayID) error
	UpsertGateways(ctx context.Context, gateways ...GatewayRecord) error
	GetRoute(ctx context.Context, id string) ([]byte, error)
	ListRoutes(ctx context.Context) ([][]byte, error)
	DeleteRoute(ctx context.Context, id string) error
	UpsertRoutes(ctx context.Context, routes ...RouteRecord) error
}

Backend is used for persisting and querying gateways and routes

type Binder

type Binder interface {
	Bind(ctx context.Context, gateway Gateway, route Route) bool
	Unbind(ctx context.Context, gateway Gateway, route Route) bool
}

type CompareResult

type CompareResult int

type Config

type Config struct {
	Adapter       core.SyncAdapter
	Backend       Backend
	Binder        Binder
	Logger        hclog.Logger
	Marshaler     Marshaler
	StatusUpdater StatusUpdater
}

type Gateway

type Gateway interface {
	ID() core.GatewayID
	Resolve() core.ResolvedGateway
	CanFetchSecrets(secrets []string) (bool, error)
}

Gateway describes a gateway.

type GatewayRecord

type GatewayRecord struct {
	ID   core.GatewayID
	Data []byte
}

GatewayRecord represents a serialized Gateway

type Marshaler

type Marshaler interface {
	UnmarshalRoute(data []byte) (Route, error)
	MarshalRoute(Route) ([]byte, error)
	UnmarshalGateway(data []byte) (Gateway, error)
	MarshalGateway(Gateway) ([]byte, error)
}

type ReadStore

type ReadStore interface {
	GetGateway(ctx context.Context, id core.GatewayID) (Gateway, error)
	ListGateways(ctx context.Context) ([]Gateway, error)

	GetRoute(ctx context.Context, id string) (Route, error)
	ListRoutes(ctx context.Context) ([]Route, error)
}

type Route

type Route interface {
	ID() string
}

Route should be implemented by all route source integrations

type RouteRecord

type RouteRecord struct {
	ID   string
	Data []byte
}

RouteRecord represents a serialized Route

type StatusUpdater

type StatusUpdater interface {
	UpdateGatewayStatusOnSync(ctx context.Context, gateway Gateway, sync func() (bool, error)) error
	UpdateRouteStatus(ctx context.Context, route Route) error
}

type Store

type Store interface {
	ReadStore
	WriteStore
}

Store is used for persisting and querying gateways and routes

type WriteStore

type WriteStore interface {
	UpsertGateway(ctx context.Context, gateway Gateway, updateConditionFn func(current Gateway) bool) error
	DeleteGateway(ctx context.Context, id core.GatewayID) error

	UpsertRoute(ctx context.Context, route Route, updateConditionFn func(current Route) bool) error
	DeleteRoute(ctx context.Context, id string) error

	SyncAllAtInterval(ctx context.Context)
}