transport

README

raft-grpc-transport

This library provides a Transport for https://github.com/hashicorp/raft over gRPC.

One benefit of this is that gRPC is easy to multiplex over a single port.

Usage

// ...
tm := transport.New(raft.ServerAddress(myAddress), []grpc.DialOption{grpc.WithInsecure()})
s := grpc.NewServer()
tm.Register(s)
r, err := raft.NewRaft(..., tm.Transport())
// ...

Want more example code? Check out main.go at https://github.com/Jille/raft-grpc-example

Documentation

Overview

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

Index

• type Manager
  • func New(localAddress raft.ServerAddress, dialOptions []grpc.DialOption, ...) *Manager
  • func (m *Manager) Close() error
  • func (m *Manager) Register(s grpc.ServiceRegistrar)
  • func (m *Manager) Transport() raft.Transport
• type Option
  • func WithHeartbeatTimeout(d time.Duration) Option

Types

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func New

func New(localAddress raft.ServerAddress, dialOptions []grpc.DialOption, 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() 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 more than d for a heartbeat to be executed by a remote peer.