appcontext

Documentation

Index

• type AppFunction
• type Context
  • func (context *Context) Complete(output []byte)
  • func (context *Context) MarkAsPushed() error

Types

type AppFunction

type AppFunction = func(edgexcontext *Context, params ...interface{}) (bool, interface{})

AppFunction is a type alias for func(edgexcontext *appcontext.Context, params ...interface{}) (bool, interface{})

type Context

type Context struct {
	// ID of the EdgeX Event -- will be filled for a received JSON Event
	EventID string
	// Checksum of the EdgeX Event -- will be filled for a received CBOR Event
	EventChecksum string
	// This is the ID used to track the EdgeX event through entire EdgeX framework.
	CorrelationID string
	// OutputData is used for specifying the data that is to be outputted. Leverage the .Complete() function to set.
	OutputData []byte
	// This holds the configuration for your service. This is the preferred way to access your custom application settings that have been set in the configuration.
	Configuration common.ConfigurationStruct
	// This is exposed to allow logging following the preferred logging strategy within EdgeX.
	LoggingClient logger.LoggingClient
	EventClient   coredata.EventClient
}

Context ...

func (*Context) Complete

func (context *Context) Complete(output []byte)

Complete is optional and provides a way to return the specified data. In the case of an HTTP Trigger, the data will be returned as the http response. In the case of the message bus trigger, the data will be placed on the specifed message bus publish topic and host in the configuration.

func (*Context) MarkAsPushed

func (context *Context) MarkAsPushed() error

MarkAsPushed ...