runtime

package

v3.1.0 Latest Latest Go to latest Published: Nov 7, 2023 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/edgexfoundry/app-functions-sdk-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewFunctionPipeline(id string, topics []string, transforms []interfaces.AppFunction) interfaces.FunctionPipeline
type FunctionsPipelineRuntime
- func NewFunctionPipelineRuntime(serviceKey string, targetType interface{}, dic *di.Container) *FunctionsPipelineRuntime
type MessageError
- func (merr *MessageError) Error() string

Constants ¶

View Source

const (
	TopicWildCard            = "#"
	TopicSingleLevelWildcard = "+"
	TopicLevelSeparator      = "/"
)

Variables ¶

This section is empty.

Functions ¶

func NewFunctionPipeline ¶

func NewFunctionPipeline(id string, topics []string, transforms []interfaces.AppFunction) interfaces.FunctionPipeline

Types ¶

type FunctionsPipelineRuntime ¶

type FunctionsPipelineRuntime struct {
	TargetType interface{}
	ServiceKey string
	// contains filtered or unexported fields
}

FunctionsPipelineRuntime represents the golang runtime environment for App Services' Functions Pipelines

func NewFunctionPipelineRuntime ¶

func NewFunctionPipelineRuntime(serviceKey string, targetType interface{}, dic *di.Container) *FunctionsPipelineRuntime

NewFunctionPipelineRuntime creates and initializes the AppServiceRuntime instance

func (*FunctionsPipelineRuntime) AddFunctionsPipeline ¶

func (fpr *FunctionsPipelineRuntime) AddFunctionsPipeline(id string, topics []string, transforms []interfaces.AppFunction) error

AddFunctionsPipeline is thread safe to set transforms

func (*FunctionsPipelineRuntime) ClearAllFunctionsPipelineTransforms ¶

func (fpr *FunctionsPipelineRuntime) ClearAllFunctionsPipelineTransforms()

ClearAllFunctionsPipelineTransforms clears the transforms for all existing function pipelines.

func (*FunctionsPipelineRuntime) DecodeMessage ¶

func (fpr *FunctionsPipelineRuntime) DecodeMessage(appContext *appfunction.Context, envelope types.MessageEnvelope) (interface{}, *MessageError, bool)

DecodeMessage decode the message wrapped in the MessageEnvelope and return the data to be processed.

func (*FunctionsPipelineRuntime) ExecutePipeline ¶

func (fpr *FunctionsPipelineRuntime) ExecutePipeline(
	target interface{},
	appContext *appfunction.Context,
	pipeline *interfaces.FunctionPipeline,
	startPosition int,
	isRetry bool) *MessageError

func (*FunctionsPipelineRuntime) GetDefaultPipeline ¶

func (fpr *FunctionsPipelineRuntime) GetDefaultPipeline() *interfaces.FunctionPipeline

func (*FunctionsPipelineRuntime) GetMatchingPipelines ¶

func (fpr *FunctionsPipelineRuntime) GetMatchingPipelines(incomingTopic string) []*interfaces.FunctionPipeline

func (*FunctionsPipelineRuntime) GetPipelineById ¶

func (fpr *FunctionsPipelineRuntime) GetPipelineById(id string) *interfaces.FunctionPipeline

func (*FunctionsPipelineRuntime) ProcessMessage ¶

func (fpr *FunctionsPipelineRuntime) ProcessMessage(appContext *appfunction.Context, target interface{}, pipeline *interfaces.FunctionPipeline) *MessageError

ProcessMessage sends the contents of the message through the functions pipeline

func (*FunctionsPipelineRuntime) RemoveAllFunctionPipelines ¶

func (fpr *FunctionsPipelineRuntime) RemoveAllFunctionPipelines()

RemoveAllFunctionPipelines removes all existing function pipelines

func (*FunctionsPipelineRuntime) SetDefaultFunctionsPipeline ¶

func (fpr *FunctionsPipelineRuntime) SetDefaultFunctionsPipeline(transforms []interfaces.AppFunction)

SetDefaultFunctionsPipeline sets the default function pipeline

func (*FunctionsPipelineRuntime) SetFunctionsPipelineTopics ¶

func (fpr *FunctionsPipelineRuntime) SetFunctionsPipelineTopics(id string, topics []string)

SetFunctionsPipelineTopics sets the topics for an existing function pipeline. Non-existent pipelines are ignored

func (*FunctionsPipelineRuntime) SetFunctionsPipelineTransforms ¶

func (fpr *FunctionsPipelineRuntime) SetFunctionsPipelineTransforms(id string, transforms []interfaces.AppFunction)

SetFunctionsPipelineTransforms sets the transforms for an existing function pipeline. Non-existent pipelines are ignored

func (*FunctionsPipelineRuntime) StartStoreAndForward ¶

func (fpr *FunctionsPipelineRuntime) StartStoreAndForward(
	appWg *sync.WaitGroup,
	appCtx context.Context,
	enabledWg *sync.WaitGroup,
	enabledCtx context.Context,
	serviceKey string)

type MessageError ¶

type MessageError struct {
	Err       error
	ErrorCode int
}

func (*MessageError) Error ¶

func (merr *MessageError) Error() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL