kncloudevents

Documentation

Index

• Constants
• func ConfigureConnectionArgs(ca *ConnectionArgs)
• func CreateHandler(handler http.Handler) http.Handler
• func RetryIfGreaterThan300(_ context.Context, response *http.Response, err error) (bool, error)
• func SelectiveRetry(_ context.Context, response *http.Response, err error) (bool, error)
• func WithShutdownTimeout(ctx context.Context, timeout time.Duration) context.Context
• func WriteHTTPRequestWithAdditionalHeaders(ctx context.Context, message binding.Message, req *nethttp.Request, ...) error
• type Backoff
• type CheckRetry
• type ConnectionArgs
• type HTTPMessageReceiver
  • func NewHTTPMessageReceiver(port int, o ...HTTPMessageReceiverOption) *HTTPMessageReceiver
  • func (recv *HTTPMessageReceiver) StartListen(ctx context.Context, handler http.Handler) error
• type HTTPMessageReceiverOption
  • func WithChecker(checker http.HandlerFunc) HTTPMessageReceiverOption
  • func WithDrainQuietPeriod(duration time.Duration) HTTPMessageReceiverOption
  • func WithReadTimeout(duration time.Duration) HTTPMessageReceiverOption
  • func WithWriteTimeout(duration time.Duration) HTTPMessageReceiverOption
• type HTTPMessageSender
  • func NewHTTPMessageSender(ca *ConnectionArgs, target string) (*HTTPMessageSender, error)
  • func NewHTTPMessageSenderWithTarget(target string) (*HTTPMessageSender, error)
  • func (s *HTTPMessageSender) NewCloudEventRequest(ctx context.Context) (*nethttp.Request, error)
  • func (s *HTTPMessageSender) NewCloudEventRequestWithTarget(ctx context.Context, target string) (*nethttp.Request, error)
  • func (s *HTTPMessageSender) Send(req *nethttp.Request) (*nethttp.Response, error)
  • func (s *HTTPMessageSender) SendWithRetries(req *nethttp.Request, config *RetryConfig) (*nethttp.Response, error)
• type RetryConfig
  • func NoRetries() RetryConfig
  • func RetryConfigFromDeliverySpec(spec v1.DeliverySpec) (RetryConfig, error)
• type TypeExtractorTransformer
  • func (a *TypeExtractorTransformer) Transform(reader binding.MessageMetadataReader, _ binding.MessageMetadataWriter) error

Constants

const (
	DefaultShutdownTimeout = time.Minute * 1
)

const RetryAfterHeader = "Retry-After"

Functions

func ConfigureConnectionArgs

func ConfigureConnectionArgs(ca *ConnectionArgs)

ConfigureConnectionArgs configures the new connection args. The existing client won't be affected, but a new one will be created. Use sparingly, because it might lead to creating a lot of clients, none of them sharing their connection pool!

func CreateHandler

func CreateHandler(handler http.Handler) http.Handler

func RetryIfGreaterThan300

func RetryIfGreaterThan300(_ context.Context, response *http.Response, err error) (bool, error)

RetryIfGreaterThan300 is a simple default implementation

func SelectiveRetry

func SelectiveRetry(_ context.Context, response *http.Response, err error) (bool, error)

SelectiveRetry is an alternative function to determine whether to retry based on response

Note - Returning true indicates a retry should occur. Returning an error will result in that

error being returned instead of any errors from the Request.

A retry is triggered for: * nil responses * emitted errors * status codes that are 5XX, 404, 408, 409, 429 as well if the statuscode is -1.

func WithShutdownTimeout

func WithShutdownTimeout(ctx context.Context, timeout time.Duration) context.Context

func WriteHTTPRequestWithAdditionalHeaders

func WriteHTTPRequestWithAdditionalHeaders(ctx context.Context, message binding.Message, req *nethttp.Request,
	additionalHeaders nethttp.Header, transformers ...binding.Transformer) error

Types

type Backoff

type Backoff func(attemptNum int, resp *http.Response) time.Duration

Backoff specifies a policy for how long to wait between retries. It is called after a failing request to determine the amount of time that should pass before trying again.

type CheckRetry

type CheckRetry func(ctx context.Context, resp *http.Response, err error) (bool, error)

CheckRetry specifies a policy for handling retries. It is called following each request with the response and error values returned by the http.Client. If CheckRetry returns false, the Client stops retrying and returns the response to the caller. If CheckRetry returns an error, that error value is returned in lieu of the error from the request. The Client will close any response body when retrying, but if the retry is aborted it is up to the CheckRetry callback to properly close any response body before returning.

type ConnectionArgs

type ConnectionArgs struct {
	// MaxIdleConns refers to the max idle connections, as in net/http/transport.
	MaxIdleConns int
	// MaxIdleConnsPerHost refers to the max idle connections per host, as in net/http/transport.
	MaxIdleConnsPerHost int
}

ConnectionArgs allow to configure connection parameters to the underlying HTTP Client transport.

type HTTPMessageReceiver

type HTTPMessageReceiver struct {

	// Used to signal when receiver is listening
	Ready chan interface{}
	// contains filtered or unexported fields
}

func NewHTTPMessageReceiver

func NewHTTPMessageReceiver(port int, o ...HTTPMessageReceiverOption) *HTTPMessageReceiver

func (*HTTPMessageReceiver) StartListen

func (recv *HTTPMessageReceiver) StartListen(ctx context.Context, handler http.Handler) error

Blocking

type HTTPMessageReceiverOption

type HTTPMessageReceiverOption func(*HTTPMessageReceiver)

HTTPMessageReceiverOption enables further configuration of a HTTPMessageReceiver.

func WithChecker

func WithChecker(checker http.HandlerFunc) HTTPMessageReceiverOption

WithChecker takes a handler func which will run as an additional health check in Drainer. kncloudevents HTTPMessageReceiver uses Drainer to perform health check. By default, Drainer directly writes StatusOK to kubelet probe if the Pod is not draining. Users can configure customized liveness and readiness check logic by defining checker here.

func WithDrainQuietPeriod

func WithDrainQuietPeriod(duration time.Duration) HTTPMessageReceiverOption

WithDrainQuietPeriod configures the QuietPeriod for the Drainer.

func WithReadTimeout

func WithReadTimeout(duration time.Duration) HTTPMessageReceiverOption

WithReadTimeout sets the HTTP server's ReadTimeout. It covers the duration from reading the entire request (Headers + Body)

func WithWriteTimeout

func WithWriteTimeout(duration time.Duration) HTTPMessageReceiverOption

WithWriteTimeout sets the HTTP server's WriteTimeout. It covers the time between end of reading Request Header to end of writing response.

type HTTPMessageSender

type HTTPMessageSender struct {
	Client *nethttp.Client
	Target string
}

HTTPMessageSender is a wrapper for an http client that can send cloudevents.Request with retries

func NewHTTPMessageSender

func NewHTTPMessageSender(ca *ConnectionArgs, target string) (*HTTPMessageSender, error)

Deprecated: Don't use this anymore, now it has the same effect of NewHTTPMessageSenderWithTarget If you need to modify the connection args, use ConfigureConnectionArgs sparingly.

func NewHTTPMessageSenderWithTarget

func NewHTTPMessageSenderWithTarget(target string) (*HTTPMessageSender, error)

func (*HTTPMessageSender) NewCloudEventRequest

func (s *HTTPMessageSender) NewCloudEventRequest(ctx context.Context) (*nethttp.Request, error)

func (*HTTPMessageSender) NewCloudEventRequestWithTarget

func (s *HTTPMessageSender) NewCloudEventRequestWithTarget(ctx context.Context, target string) (*nethttp.Request, error)

func (*HTTPMessageSender) Send

func (s *HTTPMessageSender) Send(req *nethttp.Request) (*nethttp.Response, error)

func (*HTTPMessageSender) SendWithRetries

func (s *HTTPMessageSender) SendWithRetries(req *nethttp.Request, config *RetryConfig) (*nethttp.Response, error)

type RetryConfig

type RetryConfig struct {
	// Maximum number of retries
	RetryMax int
	// These next two variables are just copied from the original DeliverySpec so
	// we can detect if anything has changed. We can not do that with the CheckRetry
	// Backoff (at least not easily).
	BackoffDelay  *string
	BackoffPolicy *v1.BackoffPolicyType

	CheckRetry CheckRetry
	Backoff    Backoff

	// RequestTimeout represents the timeout of the single request
	RequestTimeout time.Duration

	// RetryAfterMaxDuration represents an optional override for the maximum
	// value allowed for "Retry-After" headers in 429 / 503 responses.  A nil
	// value indicates no maximum override.  A value of "0" indicates "Retry-After"
	// headers are to be ignored.
	RetryAfterMaxDuration *time.Duration
}

func NoRetries

func NoRetries() RetryConfig

func RetryConfigFromDeliverySpec

func RetryConfigFromDeliverySpec(spec v1.DeliverySpec) (RetryConfig, error)

type TypeExtractorTransformer

type TypeExtractorTransformer string

func (*TypeExtractorTransformer) Transform

func (a *TypeExtractorTransformer) Transform(reader binding.MessageMetadataReader, _ binding.MessageMetadataWriter) error