Documentation
¶
Overview ¶
Package sharding is a generated GoMock package.
Index ¶
- Variables
- func IDs(shards []shard.Shard) []uint32
- func NewShards(ids []uint32, state shard.State) []shard.Shard
- type HashFn
- type HashGen
- type MockShardSet
- func (m *MockShardSet) All() []shard.Shard
- func (m *MockShardSet) AllIDs() []uint32
- func (m *MockShardSet) EXPECT() *MockShardSetMockRecorder
- func (m *MockShardSet) HashFn() HashFn
- func (m *MockShardSet) Lookup(id ident.ID) uint32
- func (m *MockShardSet) LookupShard(id uint32) (shard.Shard, error)
- func (m *MockShardSet) LookupStateByID(shardID uint32) (shard.State, error)
- func (m *MockShardSet) Max() uint32
- func (m *MockShardSet) Min() uint32
- type MockShardSetMockRecorder
- func (mr *MockShardSetMockRecorder) All() *gomock.Call
- func (mr *MockShardSetMockRecorder) AllIDs() *gomock.Call
- func (mr *MockShardSetMockRecorder) HashFn() *gomock.Call
- func (mr *MockShardSetMockRecorder) Lookup(id interface{}) *gomock.Call
- func (mr *MockShardSetMockRecorder) LookupShard(id interface{}) *gomock.Call
- func (mr *MockShardSetMockRecorder) LookupStateByID(shardID interface{}) *gomock.Call
- func (mr *MockShardSetMockRecorder) Max() *gomock.Call
- func (mr *MockShardSetMockRecorder) Min() *gomock.Call
- type ShardSet
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDuplicateShards returned when shard set contains duplicate shards ErrDuplicateShards = errors.New("duplicate shards") // ErrInvalidShardID is returned on an invalid shard ID ErrInvalidShardID = errors.New("no shard with given ID") )
Functions ¶
Types ¶
type HashFn ¶
HashFn is a sharding hash function.
func DefaultHashFn ¶
DefaultHashFn generates a HashFn based on murmur32
type HashGen ¶
HashGen generates HashFn based on the length of shards.
func NewHashGenWithSeed ¶
NewHashGenWithSeed generates a HashFnGen based on murmur32 with a given seed
type MockShardSet ¶ added in v1.6.0
type MockShardSet struct {
// contains filtered or unexported fields
}
MockShardSet is a mock of ShardSet interface.
func NewMockShardSet ¶ added in v1.6.0
func NewMockShardSet(ctrl *gomock.Controller) *MockShardSet
NewMockShardSet creates a new mock instance.
func (*MockShardSet) All ¶ added in v1.6.0
func (m *MockShardSet) All() []shard.Shard
All mocks base method.
func (*MockShardSet) AllIDs ¶ added in v1.6.0
func (m *MockShardSet) AllIDs() []uint32
AllIDs mocks base method.
func (*MockShardSet) EXPECT ¶ added in v1.6.0
func (m *MockShardSet) EXPECT() *MockShardSetMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockShardSet) HashFn ¶ added in v1.6.0
func (m *MockShardSet) HashFn() HashFn
HashFn mocks base method.
func (*MockShardSet) Lookup ¶ added in v1.6.0
func (m *MockShardSet) Lookup(id ident.ID) uint32
Lookup mocks base method.
func (*MockShardSet) LookupShard ¶ added in v1.6.0
func (m *MockShardSet) LookupShard(id uint32) (shard.Shard, error)
LookupShard mocks base method.
func (*MockShardSet) LookupStateByID ¶ added in v1.6.0
func (m *MockShardSet) LookupStateByID(shardID uint32) (shard.State, error)
LookupStateByID mocks base method.
func (*MockShardSet) Max ¶ added in v1.6.0
func (m *MockShardSet) Max() uint32
Max mocks base method.
func (*MockShardSet) Min ¶ added in v1.6.0
func (m *MockShardSet) Min() uint32
Min mocks base method.
type MockShardSetMockRecorder ¶ added in v1.6.0
type MockShardSetMockRecorder struct {
// contains filtered or unexported fields
}
MockShardSetMockRecorder is the mock recorder for MockShardSet.
func (*MockShardSetMockRecorder) All ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) All() *gomock.Call
All indicates an expected call of All.
func (*MockShardSetMockRecorder) AllIDs ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) AllIDs() *gomock.Call
AllIDs indicates an expected call of AllIDs.
func (*MockShardSetMockRecorder) HashFn ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) HashFn() *gomock.Call
HashFn indicates an expected call of HashFn.
func (*MockShardSetMockRecorder) Lookup ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) Lookup(id interface{}) *gomock.Call
Lookup indicates an expected call of Lookup.
func (*MockShardSetMockRecorder) LookupShard ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) LookupShard(id interface{}) *gomock.Call
LookupShard indicates an expected call of LookupShard.
func (*MockShardSetMockRecorder) LookupStateByID ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) LookupStateByID(shardID interface{}) *gomock.Call
LookupStateByID indicates an expected call of LookupStateByID.
func (*MockShardSetMockRecorder) Max ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) Max() *gomock.Call
Max indicates an expected call of Max.
func (*MockShardSetMockRecorder) Min ¶ added in v1.6.0
func (mr *MockShardSetMockRecorder) Min() *gomock.Call
Min indicates an expected call of Min.
type ShardSet ¶
type ShardSet interface {
// All returns a slice to the shards in this set.
All() []shard.Shard
// AllIDs returns a slice to the shard IDs in this set.
AllIDs() []uint32
// Lookup will return a shard for a given identifier.
Lookup(id ident.ID) uint32
// LookupShard will return a shard for a given shard id.
LookupShard(id uint32) (shard.Shard, error)
// LookupStateByID returns the state of the shard with a given ID.
LookupStateByID(shardID uint32) (shard.State, error)
// Min returns the smallest shard owned by this shard set.
Min() uint32
// Max returns the largest shard owned by this shard set.
Max() uint32
// HashFn returns the sharding hash function.
HashFn() HashFn
}
ShardSet contains a sharding function and a set of shards, this interface allows for potentially out of order shard sets.
func NewEmptyShardSet ¶
NewEmptyShardSet creates a new sharding scheme with an empty set of shards