rafterrors

Documentation

Overview

Package rafterrors annotates Raft errors with gRPC status codes.

Use MarkRetriable/MarkUnretriable to add a gRPC status code.

Use MarkRetriable for atomic operations like Apply, ApplyLog, Barrier, changing configuration/voters.

Use MarkUnretriable if your own application already made changes that it didn't roll back and for Restore. Restore does multiple operation, and errors could be from the first or second and it's unsafe to distinguish.

Index

• func MarkRetriable(err error) error
• func MarkUnretriable(err error) error
• func RetriableCode(err error) codes.Code
• func UnretriableCode(err error) codes.Code

Functions

func MarkRetriable

func MarkRetriable(err error) error

MarkRetriable annotates a Raft error with a gRPC status code, given that the entire operation is retriable.

func MarkUnretriable

func MarkUnretriable(err error) error

MarkUnretriable annotates a Raft error with a gRPC status code, given that the entire operation is not retriable.

func RetriableCode

func RetriableCode(err error) codes.Code

RetriableCode returns a gRPC status code for a given Raft error, given that the entire operation is retriable.

func UnretriableCode

func UnretriableCode(err error) codes.Code

Code returns a gRPC status code for a given Raft error, given that the entire operation is not retriable.