backoff

Documentation

Index

• Variables
• type Backoff
  • func DefaultBackoff() *Backoff
  • func (b *Backoff) ForAttempt(attempt int) time.Duration
  • func (b *Backoff) NextDuration() time.Duration
  • func (b *Backoff) Reset()
  • func (b *Backoff) TimeoutExceeded() bool
• type Plugin
  • func New(opts ...PluginOption) *Plugin
  • func (p *Plugin) PeerDisconnect(client *network.PeerClient)
  • func (p *Plugin) Startup(net *network.Network)
• type PluginOption
  • func WithInitialDelay(d time.Duration) PluginOption
  • func WithMaxAttempts(i int) PluginOption
  • func WithPriority(i int) PluginOption

Variables

var (

	// PluginID is used to check existence of the backoff plugin
	PluginID = (*Plugin)(nil)
)

Types

type Backoff

type Backoff struct {

	// MaxAttempts specifies max attempts to try before erroring
	MaxAttempts int
	// BackoffInterval is duration to increment each attempt
	BackoffInterval float64
	// Jitter specifies deviation from backoff interval
	Jitter float64

	// MinInterval specifies minimum time allowed for backoff interval
	MinInterval time.Duration
	// MaxInterval specifies maximum time allowed for backoff interval
	MaxInterval time.Duration
	// contains filtered or unexported fields
}

Backoff keeps track of connection retry attempts and calculates the delay between each one.

func DefaultBackoff

func DefaultBackoff() *Backoff

DefaultBackoff creates a default configuration for Backoff.

func (*Backoff) ForAttempt

func (b *Backoff) ForAttempt(attempt int) time.Duration

ForAttempt calculates the appropriate exponential duration given an attempt count

func (*Backoff) NextDuration

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

NextDuration returns the duration and increases the number of attempts

func (*Backoff) Reset

func (b *Backoff) Reset()

Reset resets the attempt number for Backoff.

func (*Backoff) TimeoutExceeded

func (b *Backoff) TimeoutExceeded() bool

TimeoutExceeded returns true if the backoff total duration has been exceeded

type Plugin

type Plugin struct {
	*network.Plugin
	// contains filtered or unexported fields
}

Plugin is the backoff plugin

func New

func New(opts ...PluginOption) *Plugin

New returns a new backoff plugin with specified options

func (*Plugin) PeerDisconnect

func (p *Plugin) PeerDisconnect(client *network.PeerClient)

PeerDisconnect implements the plugin callback

func (*Plugin) Startup

func (p *Plugin) Startup(net *network.Network)

Startup implements the plugin callback

type PluginOption

type PluginOption func(*Plugin)

PluginOption are configurable options for the backoff plugin

func WithInitialDelay

func WithInitialDelay(d time.Duration) PluginOption

WithInitialDelay specifies initial backoff interval

func WithMaxAttempts

func WithMaxAttempts(i int) PluginOption

WithMaxAttempts specifies max attempts to retry upon client disconnect

func WithPriority

func WithPriority(i int) PluginOption

WithPriority specifies plugin priority