backoff

Documentation

Index

• Variables
• type Backoff
  • func (b *Backoff) Construct() backoff.BackOff
  • func (*Backoff) Descriptor() ([]byte, []int)
  • func (m *Backoff) GetBackoffKind() BackoffKind
  • func (m *Backoff) GetConstant() *Constant
  • func (m *Backoff) GetExponential() *Exponential
  • func (*Backoff) ProtoMessage()
  • func (m *Backoff) Reset()
  • func (m *Backoff) String() string
  • func (m *Backoff) XXX_DiscardUnknown()
  • func (m *Backoff) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Backoff) XXX_Merge(src proto.Message)
  • func (m *Backoff) XXX_Size() int
  • func (m *Backoff) XXX_Unmarshal(b []byte) error
• type BackoffKind
  • func (BackoffKind) EnumDescriptor() ([]byte, []int)
  • func (x BackoffKind) String() string
• type Constant
  • func (*Constant) Descriptor() ([]byte, []int)
  • func (m *Constant) GetInterval() uint32
  • func (*Constant) ProtoMessage()
  • func (m *Constant) Reset()
  • func (m *Constant) String() string
  • func (m *Constant) XXX_DiscardUnknown()
  • func (m *Constant) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Constant) XXX_Merge(src proto.Message)
  • func (m *Constant) XXX_Size() int
  • func (m *Constant) XXX_Unmarshal(b []byte) error
• type Exponential
  • func (*Exponential) Descriptor() ([]byte, []int)
  • func (m *Exponential) GetInitialInterval() uint32
  • func (m *Exponential) GetMaxElapsedTime() uint32
  • func (m *Exponential) GetMaxInterval() uint32
  • func (m *Exponential) GetMultiplier() float32
  • func (m *Exponential) GetRandomizationFactor() float32
  • func (*Exponential) ProtoMessage()
  • func (m *Exponential) Reset()
  • func (m *Exponential) String() string
  • func (m *Exponential) XXX_DiscardUnknown()
  • func (m *Exponential) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Exponential) XXX_Merge(src proto.Message)
  • func (m *Exponential) XXX_Size() int
  • func (m *Exponential) XXX_Unmarshal(b []byte) error

Variables

var BackoffKind_name = map[int32]string{
	0: "BackoffKind_UNKNOWN",
	1: "BackoffKind_EXPONENTIAL",
	2: "BackoffKind_CONSTANT",
}

var BackoffKind_value = map[string]int32{
	"BackoffKind_UNKNOWN":     0,
	"BackoffKind_EXPONENTIAL": 1,
	"BackoffKind_CONSTANT":    2,
}

Types

type Backoff

type Backoff struct {
	// BackoffKind is the kind of backoff.
	BackoffKind BackoffKind `protobuf:"varint,1,opt,name=backoff_kind,json=backoffKind,proto3,enum=backoff.BackoffKind" json:"backoff_kind,omitempty"`
	// Exponential is the arguments for an exponential backoff.
	Exponential *Exponential `protobuf:"bytes,2,opt,name=exponential,proto3" json:"exponential,omitempty"`
	// Constant is the arugment for a constant backoff.
	Constant             *Constant `protobuf:"bytes,3,opt,name=constant,proto3" json:"constant,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Backoff configures a backoff.

func (*Backoff) Construct

func (b *Backoff) Construct() backoff.BackOff

Construct constructs the backoff. Validates the options.

func (*Backoff) Descriptor

func (*Backoff) Descriptor() ([]byte, []int)

func (*Backoff) GetBackoffKind

func (m *Backoff) GetBackoffKind() BackoffKind

func (*Backoff) GetConstant

func (m *Backoff) GetConstant() *Constant

func (*Backoff) GetExponential

func (m *Backoff) GetExponential() *Exponential

func (*Backoff) ProtoMessage

func (*Backoff) ProtoMessage()

func (*Backoff) Reset

func (m *Backoff) Reset()

func (*Backoff) String

func (m *Backoff) String() string

func (*Backoff) XXX_DiscardUnknown

func (m *Backoff) XXX_DiscardUnknown()

func (*Backoff) XXX_Marshal

func (m *Backoff) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backoff) XXX_Merge

func (m *Backoff) XXX_Merge(src proto.Message)

func (*Backoff) XXX_Size

func (m *Backoff) XXX_Size() int

func (*Backoff) XXX_Unmarshal

func (m *Backoff) XXX_Unmarshal(b []byte) error

type BackoffKind

type BackoffKind int32

BackoffKind is the kind of backoff.

const (
	// BackoffKind_UNKNOWN defaults to BackoffKind_EXPONENTIAL
	BackoffKind_BackoffKind_UNKNOWN BackoffKind = 0
	// BackoffKind_EXPONENTIAL is an exponential backoff.
	BackoffKind_BackoffKind_EXPONENTIAL BackoffKind = 1
	// BackoffKind_CONSTANT is a constant backoff.
	BackoffKind_BackoffKind_CONSTANT BackoffKind = 2
)

func (BackoffKind) EnumDescriptor

func (BackoffKind) EnumDescriptor() ([]byte, []int)

func (BackoffKind) String

func (x BackoffKind) String() string

type Constant

type Constant struct {
	// Interval is the timing to back off, in milliseconds.
	// Defaults to 5 seconds.
	Interval             uint32   `protobuf:"varint,1,opt,name=interval,proto3" json:"interval,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Constant contains constant backoff options.

func (*Constant) Descriptor

func (*Constant) Descriptor() ([]byte, []int)

func (*Constant) GetInterval

func (m *Constant) GetInterval() uint32

func (*Constant) ProtoMessage

func (*Constant) ProtoMessage()

func (*Constant) Reset

func (m *Constant) Reset()

func (*Constant) String

func (m *Constant) String() string

func (*Constant) XXX_DiscardUnknown

func (m *Constant) XXX_DiscardUnknown()

func (*Constant) XXX_Marshal

func (m *Constant) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Constant) XXX_Merge

func (m *Constant) XXX_Merge(src proto.Message)

func (*Constant) XXX_Size

func (m *Constant) XXX_Size() int

func (*Constant) XXX_Unmarshal

func (m *Constant) XXX_Unmarshal(b []byte) error

type Exponential

type Exponential struct {
	// InitialInterval is the initial interval in milliseconds.
	// Default: 800ms.
	InitialInterval uint32 `protobuf:"varint,1,opt,name=initial_interval,json=initialInterval,proto3" json:"initial_interval,omitempty"`
	// Multiplier is the timing multiplier.
	// Default: 1.8
	Multiplier float32 `protobuf:"fixed32,2,opt,name=multiplier,proto3" json:"multiplier,omitempty"`
	// MaxInterval is the maximum timing interval in milliseconds.
	// Default: 20 seconds
	MaxInterval uint32 `protobuf:"varint,3,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
	// RandomizationFactor is the randomization factor.
	// Default: 0
	RandomizationFactor float32 `protobuf:"fixed32,4,opt,name=randomization_factor,json=randomizationFactor,proto3" json:"randomization_factor,omitempty"`
	// MaxElapsedTime if set specifies a maximum time for the backoff, in milliseconds.
	// After this time the backoff and attached process terminates.
	// May be empty, might be ignored.
	MaxElapsedTime       uint32   `protobuf:"varint,5,opt,name=max_elapsed_time,json=maxElapsedTime,proto3" json:"max_elapsed_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Exponential is the exponential arguments.

func (*Exponential) Descriptor

func (*Exponential) Descriptor() ([]byte, []int)

func (*Exponential) GetInitialInterval

func (m *Exponential) GetInitialInterval() uint32

func (*Exponential) GetMaxElapsedTime

func (m *Exponential) GetMaxElapsedTime() uint32

func (*Exponential) GetMaxInterval

func (m *Exponential) GetMaxInterval() uint32

func (*Exponential) GetMultiplier

func (m *Exponential) GetMultiplier() float32

func (*Exponential) GetRandomizationFactor

func (m *Exponential) GetRandomizationFactor() float32

func (*Exponential) ProtoMessage

func (*Exponential) ProtoMessage()

func (*Exponential) Reset

func (m *Exponential) Reset()

func (*Exponential) String

func (m *Exponential) String() string

func (*Exponential) XXX_DiscardUnknown

func (m *Exponential) XXX_DiscardUnknown()

func (*Exponential) XXX_Marshal

func (m *Exponential) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Exponential) XXX_Merge

func (m *Exponential) XXX_Merge(src proto.Message)

func (*Exponential) XXX_Size

func (m *Exponential) XXX_Size() int

func (*Exponential) XXX_Unmarshal

func (m *Exponential) XXX_Unmarshal(b []byte) error