gorums

package module

Go to main page

Versions in this module

v0

v0.11.0

Jan 4, 2026

Changes in this version

+ var ErrIncomplete = errors.New("incomplete call")

+ var ErrSendFailure = errors.New("send failure")

+ var ErrTypeMismatch = errors.New("response type mismatch")

+ func Closer(t testing.TB, c io.Closer) func()

+ func Multicast[Req proto.Message](ctx *ConfigContext, msg Req, method string, opts ...CallOption) error

+ func RPCCall(ctx *NodeContext, msg proto.Message, method string) (proto.Message, error)

+ func Range(n int) iter.Seq[int]

+ func TestContext(t testing.TB, timeout time.Duration) context.Context

+ func TestServers(t testing.TB, numServers int, srvFn func(i int) ServerIface) []string

+ func Unicast[Req proto.Message](ctx *NodeContext, req Req, method string, opts ...CallOption) error

type CallOption

+ func IgnoreErrors() CallOption

+ func Interceptors[Req, Resp proto.Message](interceptors ...QuorumInterceptor[Req, Resp]) CallOption

+ type ClientCtx struct

+ func (c *ClientCtx[Req, Resp]) Config() Configuration

+ func (c *ClientCtx[Req, Resp]) Method() string

+ func (c *ClientCtx[Req, Resp]) Node(id uint32) *Node

+ func (c *ClientCtx[Req, Resp]) Nodes() []*Node

+ func (c *ClientCtx[Req, Resp]) Request() Req

+ func (c *ClientCtx[Req, Resp]) Size() int

+ type ConfigContext struct

+ func (c ConfigContext) Configuration() Configuration

type Configuration

+ func NewConfig(opts ...Option) (Configuration, error)

+ func TestConfiguration(t testing.TB, numServers int, srvFn func(i int) ServerIface, ...) Configuration

+ func (c Configuration) Manager() *Manager

+ func (c Configuration) WithoutErrors(err QuorumCallError, errorTypes ...error) NodeListOption

+ func (cfg Configuration) Context(parent context.Context) *ConfigContext

type Correctable

+ func NewCorrectable[Resp any]() *Correctable[Resp]

type ManagerOption

+ func InsecureDialOptions(_ testing.TB) ManagerOption

+ func WithDialOptions(opts ...grpc.DialOption) ManagerOption

type Message

+ func NewRequestMessage(md *ordering.Metadata, req proto.Message) *Message

type Node

+ func TestNode(t testing.TB, srvFn func(i int) ServerIface, opts ...TestOption) *Node

+ func (n *Node) Context(parent context.Context) *NodeContext

+ type NodeContext struct

+ func (c NodeContext) Node() *Node

+ type NodeResponse struct

+ Err error

+ NodeID uint32

+ Value T

+ type Option interface

type QuorumCallError

+ func TestQuorumCallError(_ testing.TB, nodeErrors map[uint32]error) QuorumCallError

+ func (e QuorumCallError) Cause() error

+ func (e QuorumCallError) NodeErrors() int

+ func (e QuorumCallError) Unwrap() (errs []error)

+ type QuorumInterceptor func(ctx *ClientCtx[Req, Resp], next ResponseSeq[Resp]) ResponseSeq[Resp]

+ func MapRequest[Req, Resp msg](fn func(Req, *Node) Req) QuorumInterceptor[Req, Resp]

+ func MapResponse[Req, Resp msg](fn func(Resp, *Node) Resp) QuorumInterceptor[Req, Resp]

+ type ResponseSeq iter.Seq[NodeResponse[T]]

+ func (seq ResponseSeq[Resp]) CollectAll() map[uint32]Resp

+ func (seq ResponseSeq[Resp]) CollectN(n int) map[uint32]Resp

+ func (seq ResponseSeq[Resp]) Filter(keep func(NodeResponse[Resp]) bool) ResponseSeq[Resp]

+ func (seq ResponseSeq[Resp]) IgnoreErrors() ResponseSeq[Resp]

+ type Responses struct

+ func NewResponses[Req, Resp msg](ctx *ClientCtx[Req, Resp]) *Responses[Resp]

+ func QuorumCallStream[Req, Resp msg](ctx *ConfigContext, req Req, method string, opts ...CallOption) *Responses[Resp]

+ func QuorumCall[Req, Resp msg](ctx *ConfigContext, req Req, method string, opts ...CallOption) *Responses[Resp]

+ func (r *Responses[Resp]) All() (Resp, error)

+ func (r *Responses[Resp]) AsyncAll() *Async[Resp]

+ func (r *Responses[Resp]) AsyncFirst() *Async[Resp]

+ func (r *Responses[Resp]) AsyncMajority() *Async[Resp]

+ func (r *Responses[Resp]) AsyncThreshold(threshold int) *Async[Resp]

+ func (r *Responses[Resp]) Correctable(threshold int) *Correctable[Resp]

+ func (r *Responses[Resp]) First() (Resp, error)

+ func (r *Responses[Resp]) Majority() (Resp, error)

+ func (r *Responses[Resp]) Seq() ResponseSeq[Resp]

+ func (r *Responses[Resp]) Size() int

+ func (r *Responses[Resp]) Threshold(threshold int) (resp Resp, err error)

type ServerIface

+ func EchoServerFn(_ int) ServerIface

+ func StreamBenchmarkServerFn(_ int) ServerIface

+ func StreamServerFn(_ int) ServerIface

+ type System struct

+ func NewSystem(addr string, opts ...ServerOption) (*System, error)

+ func (s *System) Addr() string

+ func (s *System) RegisterService(closer io.Closer, registerFunc func(*Server))

+ func (s *System) Serve() error

+ func (s *System) Stop() (errs error)

+ type TestOption any

+ func WithManager(_ testing.TB, mgr *Manager) TestOption

+ func WithPreConnect(_ testing.TB, fn func(stopServers func())) TestOption

+ func WithStopFunc(_ testing.TB, fn *func(...int)) TestOption

v0.10.0

Nov 14, 2025

Changes in this version

+ func AsProto[T proto.Message](msg *Message) T

+ type Handler func(ServerCtx, *Message) (*Message, error)

+ type Interceptor func(ServerCtx, *Message, Handler) (*Message, error)

type Message

+ func NewResponseMessage(md *ordering.Metadata, resp proto.Message) *Message

+ func (m *Message) GetMessageID() uint64

+ func (m *Message) GetMetadata() *ordering.Metadata

+ func (m *Message) GetMethod() string

+ func (m *Message) GetProtoMessage() proto.Message

+ func (m *Message) GetStatus() *status.Status

type ServerCtx

+ func (ctx *ServerCtx) SendMessage(msg *Message) error

type ServerOption

+ func WithInterceptors(i ...Interceptor) ServerOption

v0.9.0

Apr 7, 2025

v0.8.1

Mar 5, 2025

v0.8.0

Mar 5, 2025

Changes in this version

+ var Incomplete = errors.New("incomplete call")

type QuorumCallError

+ func (e QuorumCallError) Is(target error) bool

type ServerOption

+ func WithConnectCallback(callback func(context.Context)) ServerOption

v0.7.0

Jan 6, 2022

Changes in this version

+ type RawConfiguration []*RawNode

+ func NewRawConfiguration(mgr *RawManager, opt NodeListOption) (nodes RawConfiguration, err error)

+ func (c RawConfiguration) And(d RawConfiguration) NodeListOption

+ func (c RawConfiguration) AsyncCall(ctx context.Context, d QuorumCallData) *Async

+ func (c RawConfiguration) CorrectableCall(ctx context.Context, d CorrectableCallData) *Correctable

+ func (c RawConfiguration) Equal(b RawConfiguration) bool

+ func (c RawConfiguration) Except(rm RawConfiguration) NodeListOption

+ func (c RawConfiguration) Multicast(ctx context.Context, d QuorumCallData, opts ...CallOption)

+ func (c RawConfiguration) NodeIDs() []uint32

+ func (c RawConfiguration) Nodes() []*RawNode

+ func (c RawConfiguration) QuorumCall(ctx context.Context, d QuorumCallData) (resp protoreflect.ProtoMessage, err error)

+ func (c RawConfiguration) Size() int

+ func (c RawConfiguration) WithNewNodes(new NodeListOption) NodeListOption

+ func (c RawConfiguration) WithoutNodes(ids ...uint32) NodeListOption

+ type RawManager struct

+ func NewRawManager(opts ...ManagerOption) *RawManager

+ func (m *RawManager) AddNode(node *RawNode) error

+ func (m *RawManager) Close()

+ func (m *RawManager) Node(id uint32) (node *RawNode, found bool)

+ func (m *RawManager) NodeIDs() []uint32

+ func (m *RawManager) Nodes() []*RawNode

+ func (m *RawManager) Size() (nodes int)

+ type RawNode struct

+ func NewRawNode(addr string) (*RawNode, error)

+ func NewRawNodeWithID(addr string, id uint32) (*RawNode, error)

+ func (n *RawNode) Address() string

+ func (n *RawNode) FullString() string

+ func (n *RawNode) Host() string

+ func (n *RawNode) ID() uint32

+ func (n *RawNode) LastErr() error

+ func (n *RawNode) Latency() time.Duration

+ func (n *RawNode) Port() string

+ func (n *RawNode) RPCCall(ctx context.Context, d CallData) (resp protoreflect.ProtoMessage, err error)

+ func (n *RawNode) String() string

+ func (n *RawNode) Unicast(ctx context.Context, d CallData, opts ...CallOption)

v0.6.1

Dec 18, 2021

v0.6.0

Dec 13, 2021

Changes in this version

+ func SendMessage(ctx context.Context, c chan<- *Message, msg *Message) error

type Node

+ func (n *Node) Host() string

+ type ServerCtx struct

+ func (ctx *ServerCtx) Release()

v0.5.0

May 10, 2021

Changes in this version

type Node

+ func (n *Node) Latency() time.Duration

v0.4.0

Mar 27, 2021

Changes in this version

+ const GenVersion

+ const MaxVersion

+ const MinVersion

type Configuration

+ func (c Configuration) And(d Configuration) NodeListOption

+ func (c Configuration) Except(rm Configuration) NodeListOption

+ func (c Configuration) WithNewNodes(new NodeListOption) NodeListOption

+ func (c Configuration) WithoutNodes(ids ...uint32) NodeListOption

+ type EnforceVersion uint

+ type NodeListOption interface

v0.3.0

Feb 26, 2021

Changes in this version

+ const ContentSubtype

+ const LevelNotSet

+ var E_Rpc = &file_gorums_proto_extTypes[0]

+ var ID = func(n1, n2 *Node) bool

+ var LastNodeError = func(n1, n2 *Node) bool

+ var Port = func(n1, n2 *Node) bool

+ func ConfigCreationError(err error) error

+ type Async struct

+ func (f *Async) Done() bool

+ func (f *Async) Get() (protoreflect.ProtoMessage, error)

+ type CallData struct

+ Message protoreflect.ProtoMessage

+ Method string

+ type CallOption func(*callOptions)

+ func WithNoSendWaiting() CallOption

+ type Codec struct

+ func NewCodec() *Codec

+ func (c Codec) Marshal(m interface{}) (b []byte, err error)

+ func (c Codec) Name() string

+ func (c Codec) String() string

+ func (c Codec) Unmarshal(b []byte, m interface{}) (err error)

+ type ConfigOption func(*configOptions)

+ func WithNodeIDs(nodeIDs []uint32) ConfigOption

+ func WithNodeList(addrsList []string) ConfigOption

+ func WithNodeMap(idMap map[string]uint32) ConfigOption

+ type Configuration []*Node

+ func NewConfiguration(mgr *Manager, opts ...ConfigOption) (nodes Configuration, err error)

+ func (c Configuration) AsyncCall(ctx context.Context, d QuorumCallData) *Async

+ func (c Configuration) CorrectableCall(ctx context.Context, d CorrectableCallData) *Correctable

+ func (c Configuration) Equal(b Configuration) bool

+ func (c Configuration) Multicast(ctx context.Context, d QuorumCallData, opts ...CallOption)

+ func (c Configuration) NodeIDs() []uint32

+ func (c Configuration) Nodes() []*Node

+ func (c Configuration) QuorumCall(ctx context.Context, d QuorumCallData) (resp protoreflect.ProtoMessage, err error)

+ func (c Configuration) Size() int

+ type Correctable struct

+ func (c *Correctable) Done() <-chan struct{}

+ func (c *Correctable) Get() (protoreflect.ProtoMessage, int, error)

+ func (c *Correctable) Watch(level int) <-chan struct{}

+ type CorrectableCallData struct

+ Message protoreflect.ProtoMessage

+ Method string

+ PerNodeArgFn func(protoreflect.ProtoMessage, uint32) protoreflect.ProtoMessage

+ QuorumFunction func(protoreflect.ProtoMessage, map[uint32]protoreflect.ProtoMessage) (protoreflect.ProtoMessage, int, bool)

+ ServerStream bool

+ type Error struct

+ Cause error

+ NodeID uint32

+ func (e Error) Error() string

+ type Manager struct

+ func NewManager(opts ...ManagerOption) *Manager

+ func (m *Manager) AddNode(node *Node) error

+ func (m *Manager) Close()

+ func (m *Manager) Node(id uint32) (node *Node, found bool)

+ func (m *Manager) NodeIDs() []uint32

+ func (m *Manager) Nodes() []*Node

+ func (m *Manager) Size() (nodes int)

+ type ManagerOption func(*managerOptions)

+ func WithBackoff(backoff backoff.Config) ManagerOption

+ func WithDialTimeout(timeout time.Duration) ManagerOption

+ func WithGrpcDialOptions(opts ...grpc.DialOption) ManagerOption

+ func WithLogger(logger *log.Logger) ManagerOption

+ func WithMetadata(md metadata.MD) ManagerOption

+ func WithNoConnect() ManagerOption

+ func WithPerNodeMetadata(f func(uint32) metadata.MD) ManagerOption

+ func WithSendBufferSize(size uint) ManagerOption

+ type Message struct

+ Message protoreflect.ProtoMessage

+ Metadata *ordering.Metadata

+ func WrapMessage(md *ordering.Metadata, resp protoreflect.ProtoMessage, err error) *Message

+ type MultiSorter struct

+ func OrderedBy(less ...lessFunc) *MultiSorter

+ func (ms *MultiSorter) Len() int

+ func (ms *MultiSorter) Less(i, j int) bool

+ func (ms *MultiSorter) Sort(nodes []*Node)

+ func (ms *MultiSorter) Swap(i, j int)

+ type Node struct

+ func NewNode(addr string) (*Node, error)

+ func NewNodeWithID(addr string, id uint32) (*Node, error)

+ func (n *Node) Address() string

+ func (n *Node) FullString() string

+ func (n *Node) ID() uint32

+ func (n *Node) LastErr() error

+ func (n *Node) Port() string

+ func (n *Node) RPCCall(ctx context.Context, d CallData) (resp protoreflect.ProtoMessage, err error)

+ func (n *Node) String() string

+ func (n *Node) Unicast(ctx context.Context, d CallData, opts ...CallOption)

+ type QuorumCallData struct

+ Message protoreflect.ProtoMessage

+ Method string

+ PerNodeArgFn func(protoreflect.ProtoMessage, uint32) protoreflect.ProtoMessage

+ QuorumFunction func(protoreflect.ProtoMessage, map[uint32]protoreflect.ProtoMessage) (protoreflect.ProtoMessage, bool)

+ type QuorumCallError struct

+ Errors []Error

+ Reason string

+ ReplyCount int

+ func (e QuorumCallError) Error() string

+ type Server struct

+ func NewServer(opts ...ServerOption) *Server

+ func (s *Server) GracefulStop()

+ func (s *Server) RegisterHandler(method string, handler requestHandler)

+ func (s *Server) Serve(listener net.Listener) error

+ func (s *Server) Stop()

+ type ServerIface interface

+ Serve func(net.Listener) error

+ Stop func()

+ type ServerOption func(*serverOptions)

+ func WithGRPCServerOptions(opts ...grpc.ServerOption) ServerOption

+ func WithReceiveBufferSize(size uint) ServerOption

v0.2.2

Jul 20, 2020

v0.2.1

Jul 20, 2020

v0.2.0

Jun 29, 2020

Changes in this version

+ var E_Async = &file_gorums_proto_extTypes[1]

+ var E_Concurrent = &file_gorums_proto_extTypes[6]

+ var E_Correctable = &file_gorums_proto_extTypes[4]

+ var E_CustomReturnType = &file_gorums_proto_extTypes[8]

+ var E_Multicast = &file_gorums_proto_extTypes[3]

+ var E_Ordered = &file_gorums_proto_extTypes[2]

+ var E_PerNodeArg = &file_gorums_proto_extTypes[7]

+ var E_Quorumcall = &file_gorums_proto_extTypes[0]

+ var E_Unicast = &file_gorums_proto_extTypes[5]

+ var File_gorums_proto protoreflect.FileDescriptor

+ func TestSetup(t testing.TB, numServers int, regSrvFn func(*grpc.Server)) ([]string, func())

v0.1.0-gogo

Mar 14, 2020

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL