capabilities

Documentation

Index

• Variables
• func NewAggregator(name string, config values.Map, lggr logger.Logger) (types.Aggregator, error)
• func NewLauncher(lggr logger.Logger, peerWrapper p2ptypes.PeerWrapper, ...) *launcher
• type Registry
  • func NewRegistry(lggr logger.Logger) *Registry
  • func (r *Registry) Add(ctx context.Context, c capabilities.BaseCapability) error
  • func (r *Registry) ConfigForCapability(ctx context.Context, capabilityID string, donID uint32) (capabilities.CapabilityConfiguration, error)
  • func (r *Registry) Get(_ context.Context, id string) (capabilities.BaseCapability, error)
  • func (r *Registry) GetAction(ctx context.Context, id string) (capabilities.ActionCapability, error)
  • func (r *Registry) GetConsensus(ctx context.Context, id string) (capabilities.ConsensusCapability, error)
  • func (r *Registry) GetTarget(ctx context.Context, id string) (capabilities.TargetCapability, error)
  • func (r *Registry) GetTrigger(ctx context.Context, id string) (capabilities.TriggerCapability, error)
  • func (r *Registry) List(_ context.Context) ([]capabilities.BaseCapability, error)
  • func (r *Registry) LocalNode(ctx context.Context) (capabilities.Node, error)
  • func (r *Registry) SetLocalRegistry(lr metadataRegistry)

Variables

var (
	ErrCapabilityAlreadyExists = errors.New("capability already exists")
)

Functions

func NewAggregator

func NewAggregator(name string, config values.Map, lggr logger.Logger) (types.Aggregator, error)

func NewLauncher

func NewLauncher(
	lggr logger.Logger,
	peerWrapper p2ptypes.PeerWrapper,
	dispatcher remotetypes.Dispatcher,
	registry *Registry,
) *launcher

Types

type Registry

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

Registry is a struct for the registry of capabilities. Registry is safe for concurrent use.

func NewRegistry

func NewRegistry(lggr logger.Logger) *Registry

NewRegistry returns a new Registry.

func (*Registry) Add

func (r *Registry) Add(ctx context.Context, c capabilities.BaseCapability) error

Add adds a capability to the registry.

func (*Registry) ConfigForCapability

func (r *Registry) ConfigForCapability(ctx context.Context, capabilityID string, donID uint32) (capabilities.CapabilityConfiguration, error)

func (*Registry) Get

func (r *Registry) Get(_ context.Context, id string) (capabilities.BaseCapability, error)

Get gets a capability from the registry.

func (*Registry) GetAction

func (r *Registry) GetAction(ctx context.Context, id string) (capabilities.ActionCapability, error)

GetAction gets a capability from the registry and tries to coerce it to the ActionCapability interface.

func (*Registry) GetConsensus

func (r *Registry) GetConsensus(ctx context.Context, id string) (capabilities.ConsensusCapability, error)

GetConsensus gets a capability from the registry and tries to coerce it to the ConsensusCapability interface.

func (*Registry) GetTarget

func (r *Registry) GetTarget(ctx context.Context, id string) (capabilities.TargetCapability, error)

GetTarget gets a capability from the registry and tries to coerce it to the TargetCapability interface.

func (*Registry) GetTrigger

func (r *Registry) GetTrigger(ctx context.Context, id string) (capabilities.TriggerCapability, error)

GetTrigger gets a capability from the registry and tries to coerce it to the TriggerCapability interface.

func (*Registry) List

func (r *Registry) List(_ context.Context) ([]capabilities.BaseCapability, error)

List lists all the capabilities in the registry.

func (*Registry) LocalNode

func (r *Registry) LocalNode(ctx context.Context) (capabilities.Node, error)

func (*Registry) SetLocalRegistry

func (r *Registry) SetLocalRegistry(lr metadataRegistry)

SetLocalRegistry sets a local copy of the offchain registry for the registry to use. This is only public for testing purposes; the only production use should be from the CapabilitiesLauncher.