netutil

README

netutil

import "github.com/ccheers/xpkg/net/netutil"

Index

• Variables
• type Backoff
• type BackoffConfig
  • func (bc *BackoffConfig) Backoff(retries int) time.Duration

Variables

DefaultBackoffConfig uses values specified for backoff in common.

var DefaultBackoffConfig = BackoffConfig{
    MaxDelay:  120 * time.Second,
    BaseDelay: 1.0 * time.Second,
    Factor:    1.6,
    Jitter:    0.2,
}

type Backoff

Backoff defines the methodology for backing off after a call failure.

type Backoff interface {
    // Backoff returns the amount of time to wait before the next retry given
    // the number of consecutive failures.
    Backoff(retries int) time.Duration
}

type BackoffConfig

BackoffConfig defines the parameters for the default backoff strategy.

type BackoffConfig struct {
    // MaxDelay is the upper bound of backoff delay.
    MaxDelay time.Duration

    // baseDelay is the amount of time to wait before retrying after the first
    // failure.
    BaseDelay time.Duration

    // factor is applied to the backoff after each retry.
    Factor float64

    // jitter provides a range to randomize backoff delays.
    Jitter float64
}

func (*BackoffConfig) Backoff

func (bc *BackoffConfig) Backoff(retries int) time.Duration

Backoff returns the amount of time to wait before the next retry given the number of consecutive failures.

Generated by gomarkdoc

Documentation

Index

• Variables
• type Backoff
• type BackoffConfig
  • func (bc *BackoffConfig) Backoff(retries int) time.Duration

Variables

var DefaultBackoffConfig = BackoffConfig{
	MaxDelay:  120 * time.Second,
	BaseDelay: 1.0 * time.Second,
	Factor:    1.6,
	Jitter:    0.2,
}

DefaultBackoffConfig uses values specified for backoff in common.

Types

type Backoff

type Backoff interface {
	// Backoff returns the amount of time to wait before the next retry given
	// the number of consecutive failures.
	Backoff(retries int) time.Duration
}

Backoff defines the methodology for backing off after a call failure.

type BackoffConfig

type BackoffConfig struct {
	// MaxDelay is the upper bound of backoff delay.
	MaxDelay time.Duration

	// baseDelay is the amount of time to wait before retrying after the first
	// failure.
	BaseDelay time.Duration

	// factor is applied to the backoff after each retry.
	Factor float64

	// jitter provides a range to randomize backoff delays.
	Jitter float64
}

BackoffConfig defines the parameters for the default backoff strategy.

func (*BackoffConfig) Backoff

func (bc *BackoffConfig) Backoff(retries int) time.Duration

Backoff returns the amount of time to wait before the next retry given the number of consecutive failures.