package
2.1.7+incompatible
Repository: https://github.com/lilithgames/dragonboat.git
Documentation: pkg.go.dev
# README
About Drummer
Drummer is a component used in Dragonboat's tests. It has been moved into github.com/lni/dragonboat/internal in the coming release, your application is not suppose to import drummer.
# Packages
Package client contains RPC client functions and structs.
Package drummerpb is a generated protocol buffer package.
Package multiraftpb is a generated protocol buffer package.
Package server contains server programs used by the drummer package.
# Functions
AddDrummerServer adds a new drummer node with specified nodeID and address to the Drummer cluster.
EntityFailed returns whether the timeline indicates that the entity has failed.
GetClusterCollection returns known clusters from the Drummer server.
GetClusterConfig returns the configuration used by Raft clusters managed by the drummer server.
GetClusterConfigFromFile returns the DrummerConfig read from the specified configuration file.
GetClusterStates returns cluster states known to the Drummer server.
GetNodeHostCollection returns nodehosts known to the Drummer.
GRPCError converts errors defined in package multiraft to gRPC errors.
NewDB creates a new DB instance.
NewDrummer creates a new Drummer instance.
NewNodehostAPI creates a new NodehostAPI server instance.
RemoveDrummerServer removes the specified node from the Drummer cluster.
SubmitBootstrappped sets the bootstrapped flag on Drummer server.
SubmitCreateDrummerChange submits Drummer change used for defining clusters.
SubmitRegions submits regions info to the Drummer server.
# Constants
ClusterExists means DB update has been rejected as the cluster to be created already exist.
DBBootstrapped means DB update has been rejected as the DB has been bootstrapped.
DBKVFinalized indicates that the KV update is rejected as there is already a finalized record in DB with the specified key.
DBKVRejected indicates that the KV update is rejected.
DBKVUpdated means the KV update has been successfully completed.
DBUpdated indicates DB has been successfully updated.
# Variables
ErrDBKVUpdateRejected indicates that the update for KV has been rejected.
ErrInvalidRequest indicates the request can not be fulfilled as it is regarded as invalid.
# Structs
DB is the struct used to maintain the raft-backed Drummer DB.
Drummer is the main struct used by the Drummer server.
NodehostAPI implements the grpc server used for making raft IO requests.