Documentation ¶
Overview ¶
Package pb provides auto-generated protobuf messages and grpc stubs.
Index ¶
- Variables
- func RegisterRaftServer(s *grpc.Server, srv RaftServer)
- func RegisterStorageServer(s *grpc.Server, srv StorageServer)
- type AppendEntriesReq
- func (*AppendEntriesReq) Descriptor() ([]byte, []int)deprecated
- func (x *AppendEntriesReq) GetEntries() []*AppendEntriesReq_LogEntry
- func (x *AppendEntriesReq) GetLeaderCommit() uint64
- func (x *AppendEntriesReq) GetLeaderID() int32
- func (x *AppendEntriesReq) GetPrevLogIndex() uint64
- func (x *AppendEntriesReq) GetPrevLogTerm() uint64
- func (x *AppendEntriesReq) GetTerm() uint64
- func (*AppendEntriesReq) ProtoMessage()
- func (x *AppendEntriesReq) ProtoReflect() protoreflect.Message
- func (x *AppendEntriesReq) Reset()
- func (x *AppendEntriesReq) String() string
- type AppendEntriesReq_LogEntry
- func (*AppendEntriesReq_LogEntry) Descriptor() ([]byte, []int)deprecated
- func (x *AppendEntriesReq_LogEntry) GetCmd() uint32
- func (x *AppendEntriesReq_LogEntry) GetIndex() uint64
- func (x *AppendEntriesReq_LogEntry) GetKey() []byte
- func (x *AppendEntriesReq_LogEntry) GetTerm() uint64
- func (x *AppendEntriesReq_LogEntry) GetValue() []byte
- func (*AppendEntriesReq_LogEntry) ProtoMessage()
- func (x *AppendEntriesReq_LogEntry) ProtoReflect() protoreflect.Message
- func (x *AppendEntriesReq_LogEntry) Reset()
- func (x *AppendEntriesReq_LogEntry) String() string
- type AppendEntriesResp
- func (*AppendEntriesResp) Descriptor() ([]byte, []int)deprecated
- func (x *AppendEntriesResp) GetSuccess() bool
- func (x *AppendEntriesResp) GetTerm() uint64
- func (*AppendEntriesResp) ProtoMessage()
- func (x *AppendEntriesResp) ProtoReflect() protoreflect.Message
- func (x *AppendEntriesResp) Reset()
- func (x *AppendEntriesResp) String() string
- type DelReq
- type DelResp
- type GetReq
- type GetResp
- type PutReq
- type PutResp
- type RaftClient
- type RaftServer
- type RequestVoteReq
- func (*RequestVoteReq) Descriptor() ([]byte, []int)deprecated
- func (x *RequestVoteReq) GetCandidateID() int32
- func (x *RequestVoteReq) GetLastLogIndex() uint64
- func (x *RequestVoteReq) GetLastLogTerm() uint64
- func (x *RequestVoteReq) GetTerm() uint64
- func (*RequestVoteReq) ProtoMessage()
- func (x *RequestVoteReq) ProtoReflect() protoreflect.Message
- func (x *RequestVoteReq) Reset()
- func (x *RequestVoteReq) String() string
- type RequestVoteResp
- func (*RequestVoteResp) Descriptor() ([]byte, []int)deprecated
- func (x *RequestVoteResp) GetTerm() uint64
- func (x *RequestVoteResp) GetVoteGranted() bool
- func (*RequestVoteResp) ProtoMessage()
- func (x *RequestVoteResp) ProtoReflect() protoreflect.Message
- func (x *RequestVoteResp) Reset()
- func (x *RequestVoteResp) String() string
- type StorageClient
- type StorageServer
- type UnimplementedRaftServer
- type UnimplementedStorageServer
Constants ¶
This section is empty.
Variables ¶
var File_pkg_pb_raft_proto protoreflect.FileDescriptor
var File_pkg_pb_storage_proto protoreflect.FileDescriptor
Functions ¶
func RegisterRaftServer ¶
func RegisterRaftServer(s *grpc.Server, srv RaftServer)
func RegisterStorageServer ¶
func RegisterStorageServer(s *grpc.Server, srv StorageServer)
Types ¶
type AppendEntriesReq ¶
type AppendEntriesReq struct { Term uint64 `protobuf:"varint,1,opt,name=term,proto3" json:"term,omitempty"` // Leader's term. LeaderID int32 `protobuf:"varint,2,opt,name=leaderID,proto3" json:"leaderID,omitempty"` // Node id of the leader. PrevLogIndex uint64 `protobuf:"varint,3,opt,name=prevLogIndex,proto3" json:"prevLogIndex,omitempty"` // Index of log entry immediately preceding new ones. PrevLogTerm uint64 `protobuf:"varint,4,opt,name=prevLogTerm,proto3" json:"prevLogTerm,omitempty"` // Term of prevLogIndex entry. Entries []*AppendEntriesReq_LogEntry `protobuf:"bytes,5,rep,name=entries,proto3" json:"entries,omitempty"` // Log entries to store. LeaderCommit uint64 `protobuf:"varint,6,opt,name=leaderCommit,proto3" json:"leaderCommit,omitempty"` // Leader's commitIndex. // contains filtered or unexported fields }
func (*AppendEntriesReq) Descriptor
deprecated
func (*AppendEntriesReq) Descriptor() ([]byte, []int)
Deprecated: Use AppendEntriesReq.ProtoReflect.Descriptor instead.
func (*AppendEntriesReq) GetEntries ¶
func (x *AppendEntriesReq) GetEntries() []*AppendEntriesReq_LogEntry
func (*AppendEntriesReq) GetLeaderCommit ¶
func (x *AppendEntriesReq) GetLeaderCommit() uint64
func (*AppendEntriesReq) GetLeaderID ¶
func (x *AppendEntriesReq) GetLeaderID() int32
func (*AppendEntriesReq) GetPrevLogIndex ¶
func (x *AppendEntriesReq) GetPrevLogIndex() uint64
func (*AppendEntriesReq) GetPrevLogTerm ¶
func (x *AppendEntriesReq) GetPrevLogTerm() uint64
func (*AppendEntriesReq) GetTerm ¶
func (x *AppendEntriesReq) GetTerm() uint64
func (*AppendEntriesReq) ProtoMessage ¶
func (*AppendEntriesReq) ProtoMessage()
func (*AppendEntriesReq) ProtoReflect ¶
func (x *AppendEntriesReq) ProtoReflect() protoreflect.Message
func (*AppendEntriesReq) Reset ¶
func (x *AppendEntriesReq) Reset()
func (*AppendEntriesReq) String ¶
func (x *AppendEntriesReq) String() string
type AppendEntriesReq_LogEntry ¶
type AppendEntriesReq_LogEntry struct { Index uint64 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"` // Log index. Term uint64 `protobuf:"varint,2,opt,name=term,proto3" json:"term,omitempty"` // Log term. Cmd uint32 `protobuf:"varint,3,opt,name=cmd,proto3" json:"cmd,omitempty"` // Log command. Key []byte `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"` // Key associated with log command. Value []byte `protobuf:"bytes,5,opt,name=value,proto3" json:"value,omitempty"` // Value associated with log command. // contains filtered or unexported fields }
func (*AppendEntriesReq_LogEntry) Descriptor
deprecated
func (*AppendEntriesReq_LogEntry) Descriptor() ([]byte, []int)
Deprecated: Use AppendEntriesReq_LogEntry.ProtoReflect.Descriptor instead.
func (*AppendEntriesReq_LogEntry) GetCmd ¶
func (x *AppendEntriesReq_LogEntry) GetCmd() uint32
func (*AppendEntriesReq_LogEntry) GetIndex ¶
func (x *AppendEntriesReq_LogEntry) GetIndex() uint64
func (*AppendEntriesReq_LogEntry) GetKey ¶
func (x *AppendEntriesReq_LogEntry) GetKey() []byte
func (*AppendEntriesReq_LogEntry) GetTerm ¶
func (x *AppendEntriesReq_LogEntry) GetTerm() uint64
func (*AppendEntriesReq_LogEntry) GetValue ¶
func (x *AppendEntriesReq_LogEntry) GetValue() []byte
func (*AppendEntriesReq_LogEntry) ProtoMessage ¶
func (*AppendEntriesReq_LogEntry) ProtoMessage()
func (*AppendEntriesReq_LogEntry) ProtoReflect ¶
func (x *AppendEntriesReq_LogEntry) ProtoReflect() protoreflect.Message
func (*AppendEntriesReq_LogEntry) Reset ¶
func (x *AppendEntriesReq_LogEntry) Reset()
func (*AppendEntriesReq_LogEntry) String ¶
func (x *AppendEntriesReq_LogEntry) String() string
type AppendEntriesResp ¶
type AppendEntriesResp struct { Term uint64 `protobuf:"varint,1,opt,name=term,proto3" json:"term,omitempty"` // Receiver's currentTerm, for leader to update itself. Success bool `protobuf:"varint,2,opt,name=success,proto3" json:"success,omitempty"` // True means the operation succeeds, false otherwise. // contains filtered or unexported fields }
func (*AppendEntriesResp) Descriptor
deprecated
func (*AppendEntriesResp) Descriptor() ([]byte, []int)
Deprecated: Use AppendEntriesResp.ProtoReflect.Descriptor instead.
func (*AppendEntriesResp) GetSuccess ¶
func (x *AppendEntriesResp) GetSuccess() bool
func (*AppendEntriesResp) GetTerm ¶
func (x *AppendEntriesResp) GetTerm() uint64
func (*AppendEntriesResp) ProtoMessage ¶
func (*AppendEntriesResp) ProtoMessage()
func (*AppendEntriesResp) ProtoReflect ¶
func (x *AppendEntriesResp) ProtoReflect() protoreflect.Message
func (*AppendEntriesResp) Reset ¶
func (x *AppendEntriesResp) Reset()
func (*AppendEntriesResp) String ¶
func (x *AppendEntriesResp) String() string
type DelReq ¶
type DelReq struct { Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
func (*DelReq) Descriptor
deprecated
func (*DelReq) ProtoMessage ¶
func (*DelReq) ProtoMessage()
func (*DelReq) ProtoReflect ¶
func (x *DelReq) ProtoReflect() protoreflect.Message
type DelResp ¶
type DelResp struct {
// contains filtered or unexported fields
}
func (*DelResp) Descriptor
deprecated
func (*DelResp) ProtoMessage ¶
func (*DelResp) ProtoMessage()
func (*DelResp) ProtoReflect ¶
func (x *DelResp) ProtoReflect() protoreflect.Message
type GetReq ¶
type GetReq struct { Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // contains filtered or unexported fields }
func (*GetReq) Descriptor
deprecated
func (*GetReq) ProtoMessage ¶
func (*GetReq) ProtoMessage()
func (*GetReq) ProtoReflect ¶
func (x *GetReq) ProtoReflect() protoreflect.Message
type GetResp ¶
type GetResp struct { Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` Found bool `protobuf:"varint,2,opt,name=found,proto3" json:"found,omitempty"` // contains filtered or unexported fields }
func (*GetResp) Descriptor
deprecated
func (*GetResp) ProtoMessage ¶
func (*GetResp) ProtoMessage()
func (*GetResp) ProtoReflect ¶
func (x *GetResp) ProtoReflect() protoreflect.Message
type PutReq ¶
type PutReq struct { Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*PutReq) Descriptor
deprecated
func (*PutReq) ProtoMessage ¶
func (*PutReq) ProtoMessage()
func (*PutReq) ProtoReflect ¶
func (x *PutReq) ProtoReflect() protoreflect.Message
type PutResp ¶
type PutResp struct {
// contains filtered or unexported fields
}
func (*PutResp) Descriptor
deprecated
func (*PutResp) ProtoMessage ¶
func (*PutResp) ProtoMessage()
func (*PutResp) ProtoReflect ¶
func (x *PutResp) ProtoReflect() protoreflect.Message
type RaftClient ¶
type RaftClient interface { // RequestVote invoked by raft candidates to gather votes. RequestVote(ctx context.Context, in *RequestVoteReq, opts ...grpc.CallOption) (*RequestVoteResp, error) // AppendEntries invoked by raft leader to replicate log entries, also used as heartbeat. AppendEntries(ctx context.Context, in *AppendEntriesReq, opts ...grpc.CallOption) (*AppendEntriesResp, error) }
RaftClient is the client API for Raft service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewRaftClient ¶
func NewRaftClient(cc grpc.ClientConnInterface) RaftClient
type RaftServer ¶
type RaftServer interface { // RequestVote invoked by raft candidates to gather votes. RequestVote(context.Context, *RequestVoteReq) (*RequestVoteResp, error) // AppendEntries invoked by raft leader to replicate log entries, also used as heartbeat. AppendEntries(context.Context, *AppendEntriesReq) (*AppendEntriesResp, error) }
RaftServer is the server API for Raft service.
type RequestVoteReq ¶
type RequestVoteReq struct { Term uint64 `protobuf:"varint,1,opt,name=term,proto3" json:"term,omitempty"` // Candidate's term. CandidateID int32 `protobuf:"varint,2,opt,name=candidateID,proto3" json:"candidateID,omitempty"` // Node id of the candidate requesting vote. LastLogIndex uint64 `protobuf:"varint,3,opt,name=lastLogIndex,proto3" json:"lastLogIndex,omitempty"` // Index of candidate's last log entry. LastLogTerm uint64 `protobuf:"varint,4,opt,name=lastLogTerm,proto3" json:"lastLogTerm,omitempty"` // Term of candidate's last log entry. // contains filtered or unexported fields }
func (*RequestVoteReq) Descriptor
deprecated
func (*RequestVoteReq) Descriptor() ([]byte, []int)
Deprecated: Use RequestVoteReq.ProtoReflect.Descriptor instead.
func (*RequestVoteReq) GetCandidateID ¶
func (x *RequestVoteReq) GetCandidateID() int32
func (*RequestVoteReq) GetLastLogIndex ¶
func (x *RequestVoteReq) GetLastLogIndex() uint64
func (*RequestVoteReq) GetLastLogTerm ¶
func (x *RequestVoteReq) GetLastLogTerm() uint64
func (*RequestVoteReq) GetTerm ¶
func (x *RequestVoteReq) GetTerm() uint64
func (*RequestVoteReq) ProtoMessage ¶
func (*RequestVoteReq) ProtoMessage()
func (*RequestVoteReq) ProtoReflect ¶
func (x *RequestVoteReq) ProtoReflect() protoreflect.Message
func (*RequestVoteReq) Reset ¶
func (x *RequestVoteReq) Reset()
func (*RequestVoteReq) String ¶
func (x *RequestVoteReq) String() string
type RequestVoteResp ¶
type RequestVoteResp struct { Term uint64 `protobuf:"varint,1,opt,name=term,proto3" json:"term,omitempty"` // Receiver's currentTerm, for candidate to update itself. VoteGranted bool `protobuf:"varint,2,opt,name=voteGranted,proto3" json:"voteGranted,omitempty"` // True means candidate received vote, false otherwise. // contains filtered or unexported fields }
func (*RequestVoteResp) Descriptor
deprecated
func (*RequestVoteResp) Descriptor() ([]byte, []int)
Deprecated: Use RequestVoteResp.ProtoReflect.Descriptor instead.
func (*RequestVoteResp) GetTerm ¶
func (x *RequestVoteResp) GetTerm() uint64
func (*RequestVoteResp) GetVoteGranted ¶
func (x *RequestVoteResp) GetVoteGranted() bool
func (*RequestVoteResp) ProtoMessage ¶
func (*RequestVoteResp) ProtoMessage()
func (*RequestVoteResp) ProtoReflect ¶
func (x *RequestVoteResp) ProtoReflect() protoreflect.Message
func (*RequestVoteResp) Reset ¶
func (x *RequestVoteResp) Reset()
func (*RequestVoteResp) String ¶
func (x *RequestVoteResp) String() string
type StorageClient ¶
type StorageClient interface { // Get returns the value associated with given key. Get(ctx context.Context, in *GetReq, opts ...grpc.CallOption) (*GetResp, error) // Put adds or updates a key-value pair. Put(ctx context.Context, in *PutReq, opts ...grpc.CallOption) (*PutResp, error) // Del removes a key-value pair. Del(ctx context.Context, in *DelReq, opts ...grpc.CallOption) (*DelResp, error) }
StorageClient is the client API for Storage service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewStorageClient ¶
func NewStorageClient(cc grpc.ClientConnInterface) StorageClient
type StorageServer ¶
type StorageServer interface { // Get returns the value associated with given key. Get(context.Context, *GetReq) (*GetResp, error) // Put adds or updates a key-value pair. Put(context.Context, *PutReq) (*PutResp, error) // Del removes a key-value pair. Del(context.Context, *DelReq) (*DelResp, error) }
StorageServer is the server API for Storage service.
type UnimplementedRaftServer ¶
type UnimplementedRaftServer struct { }
UnimplementedRaftServer can be embedded to have forward compatible implementations.
func (*UnimplementedRaftServer) AppendEntries ¶
func (*UnimplementedRaftServer) AppendEntries(context.Context, *AppendEntriesReq) (*AppendEntriesResp, error)
func (*UnimplementedRaftServer) RequestVote ¶
func (*UnimplementedRaftServer) RequestVote(context.Context, *RequestVoteReq) (*RequestVoteResp, error)