Documentation
¶
Overview ¶
Package locker is a generated GoMock package.
Index ¶
- Constants
- Variables
- type EtcdLeaseManager
- type LeaseChangedCallback
- type Locker
- type MockEtcdLeaseManager
- func (m *MockEtcdLeaseManager) EXPECT() *MockEtcdLeaseManagerMockRecorder
- func (m *MockEtcdLeaseManager) GetLease(arg0 context.Context) (v3.LeaseID, error)
- func (m *MockEtcdLeaseManager) MarkLeaseAsDirty(arg0 context.Context, arg1 v3.LeaseID) error
- func (m *MockEtcdLeaseManager) Start(arg0 context.Context) error
- func (m *MockEtcdLeaseManager) Stop(arg0 context.Context)
- func (m *MockEtcdLeaseManager) SubscribeToLeaseChange(arg0 context.Context, arg1 LeaseChangedCallback) (string, error)
- func (m *MockEtcdLeaseManager) UnsubscribeToLeaseChange(arg0 context.Context, arg1 string) error
- type MockEtcdLeaseManagerMockRecorder
- func (mr *MockEtcdLeaseManagerMockRecorder) GetLease(arg0 interface{}) *gomock.Call
- func (mr *MockEtcdLeaseManagerMockRecorder) MarkLeaseAsDirty(arg0, arg1 interface{}) *gomock.Call
- func (mr *MockEtcdLeaseManagerMockRecorder) Start(arg0 interface{}) *gomock.Call
- func (mr *MockEtcdLeaseManagerMockRecorder) Stop(arg0 interface{}) *gomock.Call
- func (mr *MockEtcdLeaseManagerMockRecorder) SubscribeToLeaseChange(arg0, arg1 interface{}) *gomock.Call
- func (mr *MockEtcdLeaseManagerMockRecorder) UnsubscribeToLeaseChange(arg0, arg1 interface{}) *gomock.Call
Constants ¶
const DataVersion = 3
Variables ¶
var ( // ErrInvalidEtcdState is an error returned by IsMaster when the key supposed to contain the lock does not exist ErrInvalidEtcdState = errors.New("Invalid etcd state: key not found") // ErrNotMaster is an error returned by Unlock when we try to unlock an endpoint that belongs to someone else ErrNotMaster = errors.New("current host is not master of this lock") )
var ErrCallbackNotFound = errors.New(context.Background(), "lease callback not found")
ErrCallbackNotFound is launched when a user tries to delete a callback that does not exist
var ErrGetLeaseTimeout = errors.New(context.Background(), "timeout while trying to get lease")
ErrGetLeaseTimeout is launched when a user calls GetLease and we fail to provide one in time
Functions ¶
This section is empty.
Types ¶
type EtcdLeaseManager ¶
type EtcdLeaseManager interface {
Start(ctx context.Context) error
Stop(ctx context.Context)
GetLease(ctx context.Context) (etcdv3.LeaseID, error) // This will get the current lease or wait for one to be generated
MarkLeaseAsDirty(ctx context.Context, leaseID etcdv3.LeaseID) error // This is sent by clients if they think that there might be an issue with the Lease
SubscribeToLeaseChange(ctx context.Context, callback LeaseChangedCallback) (string, error) // Subscribe to lease changes. This function returns an ID that should be used to unsubscribe.
UnsubscribeToLeaseChange(ctx context.Context, id string) error // Unsubscribe from the lease changes
}
EtcdLeaseManager let you get the current server lease for the server
type LeaseChangedCallback ¶
LeaseChangedCallback is a callback called by the lease manager when the leaseID has changed so that all managers could try to regenerate their keys
type Locker ¶
type Locker interface {
Refresh(ctx context.Context) error // Refresh must be called to refresh our TTL or to try to get the lock
Unlock(ctx context.Context) error // Unlock remove the lock and mark the lock accessible for re-election
IsMaster(ctx context.Context) (bool, error) // IsMaster return true if the lock is allocated to our node
Stop(ctx context.Context) error // Stop the locker (cleanup)
}
Locker is a structure that let distribute locks across the entire networks
type MockEtcdLeaseManager ¶
type MockEtcdLeaseManager struct {
// contains filtered or unexported fields
}
MockEtcdLeaseManager is a mock of EtcdLeaseManager interface.
func NewMockEtcdLeaseManager ¶
func NewMockEtcdLeaseManager(ctrl *gomock.Controller) *MockEtcdLeaseManager
NewMockEtcdLeaseManager creates a new mock instance.
func (*MockEtcdLeaseManager) EXPECT ¶
func (m *MockEtcdLeaseManager) EXPECT() *MockEtcdLeaseManagerMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockEtcdLeaseManager) MarkLeaseAsDirty ¶
MarkLeaseAsDirty mocks base method.
func (*MockEtcdLeaseManager) Start ¶
func (m *MockEtcdLeaseManager) Start(arg0 context.Context) error
Start mocks base method.
func (*MockEtcdLeaseManager) Stop ¶
func (m *MockEtcdLeaseManager) Stop(arg0 context.Context)
Stop mocks base method.
func (*MockEtcdLeaseManager) SubscribeToLeaseChange ¶
func (m *MockEtcdLeaseManager) SubscribeToLeaseChange(arg0 context.Context, arg1 LeaseChangedCallback) (string, error)
SubscribeToLeaseChange mocks base method.
func (*MockEtcdLeaseManager) UnsubscribeToLeaseChange ¶
func (m *MockEtcdLeaseManager) UnsubscribeToLeaseChange(arg0 context.Context, arg1 string) error
UnsubscribeToLeaseChange mocks base method.
type MockEtcdLeaseManagerMockRecorder ¶
type MockEtcdLeaseManagerMockRecorder struct {
// contains filtered or unexported fields
}
MockEtcdLeaseManagerMockRecorder is the mock recorder for MockEtcdLeaseManager.
func (*MockEtcdLeaseManagerMockRecorder) GetLease ¶
func (mr *MockEtcdLeaseManagerMockRecorder) GetLease(arg0 interface{}) *gomock.Call
GetLease indicates an expected call of GetLease.
func (*MockEtcdLeaseManagerMockRecorder) MarkLeaseAsDirty ¶
func (mr *MockEtcdLeaseManagerMockRecorder) MarkLeaseAsDirty(arg0, arg1 interface{}) *gomock.Call
MarkLeaseAsDirty indicates an expected call of MarkLeaseAsDirty.
func (*MockEtcdLeaseManagerMockRecorder) Start ¶
func (mr *MockEtcdLeaseManagerMockRecorder) Start(arg0 interface{}) *gomock.Call
Start indicates an expected call of Start.
func (*MockEtcdLeaseManagerMockRecorder) Stop ¶
func (mr *MockEtcdLeaseManagerMockRecorder) Stop(arg0 interface{}) *gomock.Call
Stop indicates an expected call of Stop.
func (*MockEtcdLeaseManagerMockRecorder) SubscribeToLeaseChange ¶
func (mr *MockEtcdLeaseManagerMockRecorder) SubscribeToLeaseChange(arg0, arg1 interface{}) *gomock.Call
SubscribeToLeaseChange indicates an expected call of SubscribeToLeaseChange.
func (*MockEtcdLeaseManagerMockRecorder) UnsubscribeToLeaseChange ¶
func (mr *MockEtcdLeaseManagerMockRecorder) UnsubscribeToLeaseChange(arg0, arg1 interface{}) *gomock.Call
UnsubscribeToLeaseChange indicates an expected call of UnsubscribeToLeaseChange.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package lockermock is a generated GoMock package.
|
Package lockermock is a generated GoMock package. |