transport

Documentation

Overview

Package transport provides a Transport for github.com/hashicorp/raft over gRPC.

Index

• type CommitIndex
• type Manager
  • func New(conns *connections.Manager, options ...Option) *Manager
  • func (m *Manager) Close() (err error)
  • func (m *Manager) Register(s grpc.ServiceRegistrar)
  • func (m *Manager) Transport() raft.Transport
• type Option
  • func WithHeartbeatTimeout(d time.Duration) Option

Types

type CommitIndex

type CommitIndex interface {
	CommandCommitIndex() uint64
	LeaderCommitIndex() uint64
}

type Manager

type Manager struct {
	*connections.Manager
	// contains filtered or unexported fields
}

func New

func New(conns *connections.Manager, options ...Option) *Manager

New creates both components of raft-grpc-transport: a gRPC service and a Raft Transport.

func (*Manager) Close

func (m *Manager) Close() (err error)

func (*Manager) Register

func (m *Manager) Register(s grpc.ServiceRegistrar)

Register the RaftTransport gRPC service on a gRPC server.

func (*Manager) Transport

func (m *Manager) Transport() raft.Transport

Transport returns a raft.Transport that communicates over gRPC.

type Option

type Option func(m *Manager)

func WithHeartbeatTimeout

func WithHeartbeatTimeout(d time.Duration) Option

WithHeartbeatTimeout configures the transport to not wait for than d for heartbeat to be executes by remote peer.