channel

Documentation

Index

• Constants
• Variables
• func ReportEventCountMetricsForDispatchError(err error, reporter StatsReporter, args *ReportArgs)
• type ChannelReference
  • func ParseChannel(host string) (ChannelReference, error)
  • func (r *ChannelReference) String() string
• type DispatchExecutionInfo
• type MessageDispatcher
• type MessageDispatcherImpl
  • func NewMessageDispatcher(logger *zap.Logger) *MessageDispatcherImpl
  • func NewMessageDispatcherFromSender(logger *zap.Logger, sender *kncloudevents.HTTPMessageSender) *MessageDispatcherImpl
  • func (d *MessageDispatcherImpl) DispatchMessage(ctx context.Context, message cloudevents.Message, ...) (*DispatchExecutionInfo, error)
  • func (d *MessageDispatcherImpl) DispatchMessageWithRetries(ctx context.Context, message cloudevents.Message, ...) (*DispatchExecutionInfo, error)
• type MessageReceiver
  • func NewMessageReceiver(receiverFunc UnbufferedMessageReceiverFunc, logger *zap.Logger, ...) (*MessageReceiver, error)
  • func (r *MessageReceiver) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)
  • func (r *MessageReceiver) Start(ctx context.Context) error
• type MessageReceiverOptions
  • func ResolveMessageChannelFromHostHeader(hostToChannelFunc ResolveChannelFromHostFunc) MessageReceiverOptions
• type ReportArgs
• type ResolveChannelFromHostFunc
• type StatsReporter
  • func NewStatsReporter(container, uniqueName string) StatsReporter
• type UnbufferedMessageReceiverFunc
• type UnknownChannelError
  • func (e *UnknownChannelError) Error() string
• type UnknownHostError
  • func (e UnknownHostError) Error() string

Constants

const (
	// noDuration signals that the dispatch step hasn't started
	NoDuration = -1
	NoResponse = -1
)

const (
	// LabelUniqueName is the label for the unique name per stats_reporter instance.
	LabelUniqueName = "unique_name"

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

Variables

var (
	ContainerTagKey = tag.MustNewKey(LabelContainerName)
	UniqueTagKey    = tag.MustNewKey(LabelUniqueName)
)

Functions

func ReportEventCountMetricsForDispatchError

func ReportEventCountMetricsForDispatchError(err error, reporter StatsReporter, args *ReportArgs)

Types

type ChannelReference

type ChannelReference struct {
	Namespace string
	Name      string
}

ChannelReference references a Channel within the cluster by name and namespace.

func ParseChannel

func ParseChannel(host string) (ChannelReference, error)

ParseChannel converts the channel's hostname into a channel reference.

func (*ChannelReference) String

func (r *ChannelReference) String() string

type DispatchExecutionInfo

type DispatchExecutionInfo struct {
	Time         time.Duration
	ResponseCode int
	ResponseBody []byte
}

type MessageDispatcher

type MessageDispatcher interface {
	// DispatchMessage dispatches an event to a destination over HTTP.
	//
	// The destination and reply are URLs.
	DispatchMessage(ctx context.Context, message cloudevents.Message, additionalHeaders nethttp.Header, destination *url.URL, reply *url.URL, deadLetter *url.URL) (*DispatchExecutionInfo, error)

	// DispatchMessageWithRetries dispatches an event to a destination over HTTP.
	//
	// The destination and reply are URLs.
	DispatchMessageWithRetries(ctx context.Context, message cloudevents.Message, additionalHeaders nethttp.Header, destination *url.URL, reply *url.URL, deadLetter *url.URL, config *kncloudevents.RetryConfig, transformers ...binding.Transformer) (*DispatchExecutionInfo, error)
}

type MessageDispatcherImpl

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

MessageDispatcherImpl dispatches events to a destination over HTTP.

func NewMessageDispatcher

func NewMessageDispatcher(logger *zap.Logger) *MessageDispatcherImpl

NewMessageDispatcherFromConfig creates a new Message dispatcher based on config.

func NewMessageDispatcherFromSender

func NewMessageDispatcherFromSender(logger *zap.Logger, sender *kncloudevents.HTTPMessageSender) *MessageDispatcherImpl

NewMessageDispatcherFromConfig creates a new event dispatcher.

func (*MessageDispatcherImpl) DispatchMessage

func (d *MessageDispatcherImpl) DispatchMessage(ctx context.Context, message cloudevents.Message, additionalHeaders nethttp.Header, destination *url.URL, reply *url.URL, deadLetter *url.URL) (*DispatchExecutionInfo, error)

func (*MessageDispatcherImpl) DispatchMessageWithRetries

func (d *MessageDispatcherImpl) DispatchMessageWithRetries(ctx context.Context, message cloudevents.Message, additionalHeaders nethttp.Header, destination *url.URL, reply *url.URL, deadLetter *url.URL, retriesConfig *kncloudevents.RetryConfig, transformers ...binding.Transformer) (*DispatchExecutionInfo, error)

type MessageReceiver

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

MessageReceiver starts a server to receive new events for the channel dispatcher. The new event is emitted via the receiver function.

func NewMessageReceiver

func NewMessageReceiver(receiverFunc UnbufferedMessageReceiverFunc, logger *zap.Logger, reporter StatsReporter, opts ...MessageReceiverOptions) (*MessageReceiver, error)

NewMessageReceiver creates an event receiver passing new events to the receiverFunc.

func (*MessageReceiver) ServeHTTP

func (r *MessageReceiver) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)

func (*MessageReceiver) Start

func (r *MessageReceiver) Start(ctx context.Context) error

Start begins to receive events for the receiver.

Only HTTP POST requests to the root path (/) are accepted. If other paths or methods are needed, use the HandleRequest method directly with another HTTP server.

type MessageReceiverOptions

type MessageReceiverOptions func(*MessageReceiver) error

ReceiverOptions provides functional options to MessageReceiver function.

func ResolveMessageChannelFromHostHeader

func ResolveMessageChannelFromHostHeader(hostToChannelFunc ResolveChannelFromHostFunc) MessageReceiverOptions

ResolveMessageChannelFromHostHeader is a ReceiverOption for NewMessageReceiver which enables the caller to overwrite the default behaviour defined by ParseChannel function.

type ReportArgs

type ReportArgs struct {
	Ns        string
	EventType string
}

type ResolveChannelFromHostFunc

type ResolveChannelFromHostFunc func(string) (ChannelReference, error)

ResolveChannelFromHostFunc function enables EventReceiver to get the Channel Reference from incoming request HostHeader before calling receiverFunc. Returns UnknownHostError if the channel is not found, otherwise returns a generic error.

type StatsReporter

type StatsReporter interface {
	ReportEventCount(args *ReportArgs, responseCode int) error
	ReportEventDispatchTime(args *ReportArgs, responseCode int, d time.Duration) error
}

func NewStatsReporter

func NewStatsReporter(container, uniqueName string) StatsReporter

NewStatsReporter creates a reporter that collects and reports channel metrics.

type UnbufferedMessageReceiverFunc

type UnbufferedMessageReceiverFunc func(context.Context, ChannelReference, binding.Message, []binding.Transformer, nethttp.Header) error

UnbufferedMessageReceiverFunc is the function to be called for handling the message. The provided message is not buffered, so it can't be safely read more times. When you perform the write (or the buffering) of the Message, you must use the transformers provided as parameters. This function is responsible for invoking Message.Finish().

type UnknownChannelError

type UnknownChannelError struct {
	Channel ChannelReference
}

UnknownChannelError represents the error when an event is received by a channel dispatcher for a channel that does not exist.

func (*UnknownChannelError) Error

func (e *UnknownChannelError) Error() string

type UnknownHostError

type UnknownHostError string

UnknownHostError represents the error when a ResolveMessageChannelFromHostHeader func cannot resolve an host

func (UnknownHostError) Error

func (e UnknownHostError) Error() string