leaderworker

Documentation

Index

• type DefaultListener
  • func (l *DefaultListener) AfterExecOnLeader(ctx context.Context)
  • func (l *DefaultListener) BeforeExecOnLeader(ctx context.Context)
• type Event
• type ForLeaderUseInterface
• type ForWorkerUseInterface
• type GeneralInterface
• type Interface
• type Listener
• type WorkerAddHandler
• type WorkerDeleteHandler

Types

type DefaultListener

type DefaultListener struct {
	BeforeExecOnLeaderFunc func(ctx context.Context)
	AfterExecOnLeaderFunc  func(ctx context.Context)
}

DefaultListener just overwrite necessary func fields.

func (*DefaultListener) AfterExecOnLeader

func (l *DefaultListener) AfterExecOnLeader(ctx context.Context)

func (*DefaultListener) BeforeExecOnLeader

func (l *DefaultListener) BeforeExecOnLeader(ctx context.Context)

type Event

type Event struct {
	Type         mvccpb.Event_EventType
	WorkerID     worker.ID
	LogicTaskIDs []worker.LogicTaskID
}

type ForLeaderUseInterface

type ForLeaderUseInterface interface {
	// OnLeader register hook which will be invoked on leader if you are leader.
	// You can register multiple hooks as you need.
	// All hooks executed asynchronously.
	OnLeader(func(context.Context))

	// LeaderHookOnWorkerAdd register hook which will be invoked on worker add if you are leader.
	// You can register multiple hooks as you need.
	// All hooks executed asynchronously.
	LeaderHookOnWorkerAdd(WorkerAddHandler)

	// LeaderHookOnWorkerDelete register hook which will be invoked on worker delete if you are leader.
	// You can register multiple hooks as you need.
	// All hooks executed asynchronously.
	LeaderHookOnWorkerDelete(WorkerDeleteHandler)

	// AssignLogicTaskToWorker assign one logic task to one concrete worker.
	AssignLogicTaskToWorker(ctx context.Context, workerID worker.ID, logicTask worker.LogicTask) error

	// IsTaskBeingProcessed check if one task is being processed and the corresponding worker id.
	IsTaskBeingProcessed(ctx context.Context, logicTaskID worker.LogicTaskID) (bool, worker.ID)

	// RegisterLeaderListener provide more hook ability to customize leader behaviours.
	// See DefaultListener to simply your code.
	RegisterLeaderListener(l Listener)

	// LoadCancelingTasks load canceling tasks.
	// TODO use AfterExecOnLeaderFunc on lw side, but OnLeaderHandler should could select async or not.
	LoadCancelingTasks(ctx context.Context)
}

type ForWorkerUseInterface

type ForWorkerUseInterface interface {
	// RegisterCandidateWorker register candidate worker, and will be promoted to official automatically.
	RegisterCandidateWorker(ctx context.Context, w worker.Worker) error

	// WorkerHookOnWorkerDelete register hook which will be invoked on worker delete if you are worker.
	// You can register multiple hooks as you need.
	// All hooks executed asynchronously.
	WorkerHookOnWorkerDelete(WorkerDeleteHandler)
}

type GeneralInterface

type GeneralInterface interface {
	// ListWorkers list active workers by types, default list all types.
	ListWorkers(ctx context.Context, workerTypes ...worker.Type) ([]worker.Worker, error)

	// ListenPrefix continuously listen key prefix until context done.
	ListenPrefix(ctx context.Context, prefix string, putHandler, deleteHandler func(context.Context, *clientv3.Event))

	// Start means all hooks registered. You can't register any hooks after started.
	Start()

	// CancelLogicTask cancel logic task.
	CancelLogicTask(ctx context.Context, logicTaskID worker.LogicTaskID) error
}

type Interface

type Interface interface {
	ForLeaderUseInterface
	ForWorkerUseInterface
	GeneralInterface
}

type Listener

type Listener interface {
	BeforeExecOnLeader(ctx context.Context)
	AfterExecOnLeader(ctx context.Context)
}

type WorkerAddHandler

type WorkerAddHandler func(ctx context.Context, ev Event)

type WorkerDeleteHandler

type WorkerDeleteHandler func(ctx context.Context, ev Event)