broker

Documentation

Index

• Constants
• Variables
• func DeleteTTL(ctx cloudevents.EventContext) error
• func GetTTL(ctx cloudevents.EventContext) (int32, error)
• func SetTTL(ctx cloudevents.EventContext, ttl int32) error
• func TTLDefaulter(logger *zap.Logger, defaultTTL int32) client.EventDefaulter

Constants

const (
	// EventArrivalTime is used to access the metadata stored on a
	// CloudEvent to measure the time difference between when an event is
	// received on a broker and before it is dispatched to the trigger function.
	// The format is an RFC3339 time in string format. For example: 2019-08-26T23:38:17.834384404Z.
	EventArrivalTime = "knativearrivaltime"

	// LabelContainerName is the label for the immutable name of the container.
	LabelContainerName = "container_name"

	// LabelPodName is the label for the immutable name of the pod.
	LabelPodName = "pod_name"
)

const (
	// TTLAttribute is the name of the CloudEvents extension attribute used to store the
	// Broker's TTL (number of times a single event can reply through a Broker continuously). All
	// interactions with the attribute should be done through the GetTTL and SetTTL functions.
	TTLAttribute = "knativebrokerttl"
)

Variables

var (
	PodTagKey       = tag.MustNewKey(LabelPodName)
	ContainerTagKey = tag.MustNewKey(LabelContainerName)
)

Functions

func DeleteTTL

func DeleteTTL(ctx cloudevents.EventContext) error

DeleteTTL removes the TTL CE extension attribute

func GetTTL

func GetTTL(ctx cloudevents.EventContext) (int32, error)

GetTTL finds the TTL in the EventContext using a case insensitive comparison for the key. The second return param, is the case preserved key that matched. Depending on the encoding/transport, the extension case could be changed.

func SetTTL

func SetTTL(ctx cloudevents.EventContext, ttl int32) error

SetTTL sets the TTL into the EventContext. ttl should be a positive integer.

func TTLDefaulter

func TTLDefaulter(logger *zap.Logger, defaultTTL int32) client.EventDefaulter

TTLDefaulter returns a cloudevents event defaulter that will manage the TTL for events with the following rules:

If TTL is not found, it will set it to the default passed in.
If TTL is <= 0, it will remain 0.
If TTL is > 1, it will be reduced by one.