fulfillment

Documentation

Index

• type Fulfiller
  • func NewNoop(f map[string]interface{}, name string, a actions.Action, ...) (Fulfiller, error)
  • func NewPoller(f map[string]interface{}, name string, a actions.Action, ...) (Fulfiller, error)
• type NoopFulfillment
  • func (n NoopFulfillment) Execute(ctx context.Context, rs results.Results) <-chan results.Result
  • func (n NoopFulfillment) Name() string
• type Poller
  • func (p Poller) Execute(ctx context.Context, rs results.Results) <-chan results.Result
  • func (p Poller) Name() string
• type Registry
  • func NewRegistry() (Registry, error)
  • func (r Registry) Load(f map[string]interface{}, name string, a actions.Action, ...) (Fulfiller, error)

Types

type Fulfiller

type Fulfiller interface {
	Execute(ctx context.Context, rs results.Results) <-chan results.Result
	Name() string
}

Fulfiller executes and return results

func NewNoop

func NewNoop(f map[string]interface{}, name string, a actions.Action, cs transcons.Conditions) (Fulfiller, error)

NewNoop initializes noop fulfiller

func NewPoller

func NewPoller(f map[string]interface{}, name string, a actions.Action, cs transcons.Conditions) (Fulfiller, error)

NewPoller parses, initializes and returns a configured poller

type NoopFulfillment

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

NoopFulfillment stores actions and conditions

func (NoopFulfillment) Execute

func (n NoopFulfillment) Execute(ctx context.Context, rs results.Results) <-chan results.Result

Execute calls an action and sends its result

func (NoopFulfillment) Name

func (n NoopFulfillment) Name() string

Name is a string identifier for this fulfiller

type Poller

type Poller struct {
	Interval time.Duration
	Timeout  time.Duration
	// contains filtered or unexported fields
}

Poller contains actions and conditions, and polling configuration

func (Poller) Execute

func (p Poller) Execute(ctx context.Context, rs results.Results) <-chan results.Result

Execute Naively has a timeout, needs context, interval can execute longer than timeout

func (Poller) Name

func (p Poller) Name() string

Name identifies this poller

type Registry

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

Registry contains fulfiller string identifiers mapped to loader functions

func NewRegistry

func NewRegistry() (Registry, error)

NewRegistry creates a usable registry

func (Registry) Load

func (r Registry) Load(f map[string]interface{}, name string, a actions.Action, cs transcons.Conditions) (Fulfiller, error)

Load parses a generic map into a fulfiller