error

Documentation

Overview

Package error exists only to break an import loop.

Index

• Variables
• func EnsurePermanent(err error) error
• func IsPermanent(err error) bool
• func IsRelayable(err error) bool
• func Permanent(err error) error
• func Relayable(err error) error
• func ShouldRelay(err error) bool

Variables

var ErrUnhandledMessage = errors.New("unhandled message")

ErrUnhandledMessage indicates to the dispatcher that the handler didn't handle the message. It should be returned plainly, not wrapped as permanent or relayable.

Functions

func EnsurePermanent

func EnsurePermanent(err error) error

EnsurePermanent ensures an error will be correctly treated as (non-)permanent by `cenkalti/backoff/v4`.

Note: `IsPermanent` special cases `conext.Canceled` and doesn't ever handle it as a permanent error.

func IsPermanent

func IsPermanent(err error) bool

IsPermanent returns true iff the error is a permanent p2p message handler error.

func IsRelayable

func IsRelayable(err error) bool

IsRelayable returns true if the error is relayable.

func Permanent

func Permanent(err error) error

Permanent wraps an error returned by various handler functions to suppress retry.

func Relayable

func Relayable(err error) error

Relayable wraps an error returned by various handler functions to mark the error as relayable.

func ShouldRelay

func ShouldRelay(err error) bool

ShouldRelay returns if true the message should be relayed despite the error.

In adition to all non-permanent errors, errors that are explicitly marked as relayable should be relayed.