common

Documentation

Overview

Package common contains various helpers for adapters.

Index

• type Backoff
  • func NewBackoff(args ...time.Duration) *Backoff
  • func (b *Backoff) Duration() time.Duration
  • func (b *Backoff) Reset()
  • func (b *Backoff) Run(stopCh <-chan struct{}, fn RunFunc) error
• type RunFunc

Types

type Backoff

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

Backoff provides a simple exponential backoff mechanism.

func NewBackoff

func NewBackoff(args ...time.Duration) *Backoff

NewBackoff accepts optional values for minimum and maximum wait period and returns a new instance of Backoff.

func (*Backoff) Duration

func (b *Backoff) Duration() time.Duration

Duration returns the exponential backoff duration calculated for the current step.

func (*Backoff) Reset

func (b *Backoff) Reset()

Reset sets step counter to zero.

func (*Backoff) Run

func (b *Backoff) Run(stopCh <-chan struct{}, fn RunFunc) error

Run is a blocking function that executes RunFunc until stopCh receives a value or fn returns an error.

type RunFunc

type RunFunc func(context.Context) (bool, error)

RunFunc is a user function that polls data from a source and sends it as a CloudEvent to a sink. RunFunc must return (bool, error) values where bool is true if the poll backoff duration must be reset, and error is the result of the function's execution.