pb

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2023 License: GPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package pb provides auto-generated protobuf messages and grpc stubs.

Index

Constants

This section is empty.

Variables

View Source
var File_pkg_pb_raft_proto protoreflect.FileDescriptor
View Source
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 (*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) Descriptor() ([]byte, []int)

Deprecated: Use DelReq.ProtoReflect.Descriptor instead.

func (*DelReq) GetKey

func (x *DelReq) GetKey() []byte

func (*DelReq) ProtoMessage

func (*DelReq) ProtoMessage()

func (*DelReq) ProtoReflect

func (x *DelReq) ProtoReflect() protoreflect.Message

func (*DelReq) Reset

func (x *DelReq) Reset()

func (*DelReq) String

func (x *DelReq) String() string

type DelResp

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

func (*DelResp) Descriptor deprecated

func (*DelResp) Descriptor() ([]byte, []int)

Deprecated: Use DelResp.ProtoReflect.Descriptor instead.

func (*DelResp) ProtoMessage

func (*DelResp) ProtoMessage()

func (*DelResp) ProtoReflect

func (x *DelResp) ProtoReflect() protoreflect.Message

func (*DelResp) Reset

func (x *DelResp) Reset()

func (*DelResp) String

func (x *DelResp) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use GetReq.ProtoReflect.Descriptor instead.

func (*GetReq) GetKey

func (x *GetReq) GetKey() []byte

func (*GetReq) ProtoMessage

func (*GetReq) ProtoMessage()

func (*GetReq) ProtoReflect

func (x *GetReq) ProtoReflect() protoreflect.Message

func (*GetReq) Reset

func (x *GetReq) Reset()

func (*GetReq) String

func (x *GetReq) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use GetResp.ProtoReflect.Descriptor instead.

func (*GetResp) GetFound

func (x *GetResp) GetFound() bool

func (*GetResp) GetValue

func (x *GetResp) GetValue() []byte

func (*GetResp) ProtoMessage

func (*GetResp) ProtoMessage()

func (*GetResp) ProtoReflect

func (x *GetResp) ProtoReflect() protoreflect.Message

func (*GetResp) Reset

func (x *GetResp) Reset()

func (*GetResp) String

func (x *GetResp) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use PutReq.ProtoReflect.Descriptor instead.

func (*PutReq) GetKey

func (x *PutReq) GetKey() []byte

func (*PutReq) GetValue

func (x *PutReq) GetValue() []byte

func (*PutReq) ProtoMessage

func (*PutReq) ProtoMessage()

func (*PutReq) ProtoReflect

func (x *PutReq) ProtoReflect() protoreflect.Message

func (*PutReq) Reset

func (x *PutReq) Reset()

func (*PutReq) String

func (x *PutReq) String() string

type PutResp

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

func (*PutResp) Descriptor deprecated

func (*PutResp) Descriptor() ([]byte, []int)

Deprecated: Use PutResp.ProtoReflect.Descriptor instead.

func (*PutResp) ProtoMessage

func (*PutResp) ProtoMessage()

func (*PutResp) ProtoReflect

func (x *PutResp) ProtoReflect() protoreflect.Message

func (*PutResp) Reset

func (x *PutResp) Reset()

func (*PutResp) String

func (x *PutResp) String() string

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) RequestVote

type UnimplementedStorageServer

type UnimplementedStorageServer struct {
}

UnimplementedStorageServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageServer) Del

func (*UnimplementedStorageServer) Get

func (*UnimplementedStorageServer) Put

Jump to

Keyboard shortcuts

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