engine

Documentation

Index

• func New(state api.State, h historian.Client, rm api.RuntimeManager, logger logr.Logger) api.ManagerEngine
• type Dummy
  • func (*Dummy) Append(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error
  • func (*Dummy) FeatureDescriptor(ctx context.Context, selector string) (api.FeatureDescriptor, error)
  • func (*Dummy) Get(ctx context.Context, selector string, keys api.Keys) (api.Value, api.FeatureDescriptor, error)
  • func (d *Dummy) GetDataSource(_ string) (api.DataSource, error)
  • func (*Dummy) Incr(ctx context.Context, FQN string, keys api.Keys, by any, ts time.Time) error
  • func (*Dummy) Set(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error
  • func (*Dummy) Update(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error
• type FeaturePipeliner
  • func FeatureWithEngine(e api.ExtendedManager, in *manifests.Feature) (*FeaturePipeliner, error)
  • func (f *FeaturePipeliner) AddPostGetMiddleware(priority int, fn api.Middleware)
  • func (f *FeaturePipeliner) AddPostSetMiddleware(priority int, fn api.Middleware)
  • func (f *FeaturePipeliner) AddPreGetMiddleware(priority int, fn api.Middleware)
  • func (f *FeaturePipeliner) AddPreSetMiddleware(priority int, fn api.Middleware)
  • func (f *FeaturePipeliner) Context(ctx context.Context, selector string, logger logr.Logger) (context.Context, context.CancelFunc, error)
• type Middlewares
• type Pipeline
  • func (p Pipeline) Apply(ctx context.Context, keys api.Keys, first api.Value) (api.Value, error)

Functions

func New

func New(state api.State, h historian.Client, rm api.RuntimeManager, logger logr.Logger) api.ManagerEngine

New creates a new engine manager

Types

type Dummy

type Dummy struct {
	DataSource api.DataSource
	api.RuntimeManager
}

func (*Dummy) Append

func (*Dummy) Append(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error

func (*Dummy) FeatureDescriptor

func (*Dummy) FeatureDescriptor(ctx context.Context, selector string) (api.FeatureDescriptor, error)

func (*Dummy) Get

func (*Dummy) Get(ctx context.Context, selector string, keys api.Keys) (api.Value, api.FeatureDescriptor, error)

func (*Dummy) GetDataSource

func (d *Dummy) GetDataSource(_ string) (api.DataSource, error)

func (*Dummy) Incr

func (*Dummy) Incr(ctx context.Context, FQN string, keys api.Keys, by any, ts time.Time) error

func (*Dummy) Set

func (*Dummy) Set(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error

func (*Dummy) Update

func (*Dummy) Update(ctx context.Context, FQN string, keys api.Keys, val any, ts time.Time) error

type FeaturePipeliner

type FeaturePipeliner struct {
	api.FeatureDescriptor
	// contains filtered or unexported fields
}

FeaturePipeliner is a Core's engine feature abstraction. It contains the FD and the pipelines.

func FeatureWithEngine

func FeatureWithEngine(e api.ExtendedManager, in *manifests.Feature) (*FeaturePipeliner, error)

FeatureWithEngine converts the k8s manifests.Feature CRD to the internal engine implementation and wraps it in a pipeliner. This is useful as a standalone function for validating features.

func (*FeaturePipeliner) AddPostGetMiddleware

func (f *FeaturePipeliner) AddPostGetMiddleware(priority int, fn api.Middleware)

AddPostGetMiddleware adds a post-get hook to the feature abstraction.

func (*FeaturePipeliner) AddPostSetMiddleware

func (f *FeaturePipeliner) AddPostSetMiddleware(priority int, fn api.Middleware)

AddPostSetMiddleware adds a post-set hook to the feature abstraction.

func (*FeaturePipeliner) AddPreGetMiddleware

func (f *FeaturePipeliner) AddPreGetMiddleware(priority int, fn api.Middleware)

AddPreGetMiddleware adds a pre-get hook to the feature abstraction.

func (*FeaturePipeliner) AddPreSetMiddleware

func (f *FeaturePipeliner) AddPreSetMiddleware(priority int, fn api.Middleware)

AddPreSetMiddleware adds a pre-set hook to the feature abstraction.

func (*FeaturePipeliner) Context

func (f *FeaturePipeliner) Context(ctx context.Context, selector string, logger logr.Logger) (context.Context, context.CancelFunc, error)

Context returns a new context with the feature attached.

type Middlewares

type Middlewares []api.Middleware

type Pipeline

type Pipeline struct {
	Middlewares
	api.FeatureDescriptor
}

func (Pipeline) Apply

func (p Pipeline) Apply(ctx context.Context, keys api.Keys, first api.Value) (api.Value, error)