fanout

Documentation

Overview

Package fanout provides an http.Handler that takes in one request and fans it out to N other requests, based on a list of Subscriptions. Logically, it represents all the Subscriptions to a single Knative Channel. It will normally be used in conjunction with multichannelfanout.MessageHandler, which contains multiple fanout.MessageHandler, each corresponding to a single Knative Channel.

Index

• func ParseDispatchResultAndReportMetrics(result DispatchResult, reporter channel.StatsReporter, ...) error
• type Config
• type DispatchResult
  • func NewDispatchResult(err error, info *channel.DispatchExecutionInfo) DispatchResult
  • func (d DispatchResult) Error() error
  • func (d DispatchResult) Info() *channel.DispatchExecutionInfo
• type FanoutMessageHandler
  • func NewFanoutMessageHandler(logger *zap.Logger, messageDispatcher channel.MessageDispatcher, config Config, ...) (*FanoutMessageHandler, error)
  • func (f *FanoutMessageHandler) GetSubscriptions(ctx context.Context) []Subscription
  • func (f *FanoutMessageHandler) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)
  • func (f *FanoutMessageHandler) SetSubscriptions(ctx context.Context, subs []Subscription)
• type MessageHandler
• type Subscription
  • func SubscriberSpecToFanoutConfig(sub eventingduckv1.SubscriberSpec) (*Subscription, error)

Functions

func ParseDispatchResultAndReportMetrics

func ParseDispatchResultAndReportMetrics(result DispatchResult, reporter channel.StatsReporter, reportArgs channel.ReportArgs) error

ParseDispatchResultAndReportMetric processes the dispatch result and records the related channel metrics with the appropriate context

Types

type Config

type Config struct {
	Subscriptions []Subscription `json:"subscriptions"`
	// AsyncHandler controls whether the Subscriptions are called synchronous or asynchronously.
	// It is expected to be false when used as a sidecar.
	AsyncHandler bool `json:"asyncHandler,omitempty"`
}

Config for a fanout.MessageHandler.

type DispatchResult

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

func NewDispatchResult

func NewDispatchResult(err error, info *channel.DispatchExecutionInfo) DispatchResult

func (DispatchResult) Error

func (d DispatchResult) Error() error

func (DispatchResult) Info

func (d DispatchResult) Info() *channel.DispatchExecutionInfo

type FanoutMessageHandler

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

MessageHandler is a http.Handler that takes a single request in and fans it out to N other servers.

func NewFanoutMessageHandler

func NewFanoutMessageHandler(logger *zap.Logger, messageDispatcher channel.MessageDispatcher, config Config, reporter channel.StatsReporter) (*FanoutMessageHandler, error)

func (*FanoutMessageHandler) GetSubscriptions

func (f *FanoutMessageHandler) GetSubscriptions(ctx context.Context) []Subscription

func (*FanoutMessageHandler) ServeHTTP

func (f *FanoutMessageHandler) ServeHTTP(response nethttp.ResponseWriter, request *nethttp.Request)

func (*FanoutMessageHandler) SetSubscriptions

func (f *FanoutMessageHandler) SetSubscriptions(ctx context.Context, subs []Subscription)

type MessageHandler

type MessageHandler interface {
	nethttp.Handler
	SetSubscriptions(ctx context.Context, subs []Subscription)
	GetSubscriptions(ctx context.Context) []Subscription
}

MessageHandler is an http.Handler but has methods for managing the fanout Subscriptions. Get/Set methods are synchronized, and GetSubscriptions returns a copy of the Subscriptions, so you can use it to fetch a snapshot and use it after that safely.

type Subscription

type Subscription struct {
	Subscriber  *url.URL
	Reply       *url.URL
	DeadLetter  *url.URL
	RetryConfig *kncloudevents.RetryConfig
}

func SubscriberSpecToFanoutConfig

func SubscriberSpecToFanoutConfig(sub eventingduckv1.SubscriberSpec) (*Subscription, error)