package
8.2.0+incompatible
Repository: https://github.com/pingcap/tiflow.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

CreateWorkerWithResourceRequirements specifies the resource requirement of a worker.
CreateWorkerWithSelectors specifies the selectors used to dispatch the worker.
MockBaseMaster returns a mock DefaultBaseMaster.
MockBaseMasterCreateWorker mocks to create worker in base master.
MockBaseMasterCreateWorkerMetScheduleTaskError mocks ScheduleTask meets error.
MockBaseMasterWorkerHeartbeat sends HeartbeatPingMessage with mock message handler.
MockBaseMasterWorkerUpdateStatus mocks to store status in metastore and sends WorkerStatusMessage.
MockBaseWorker creates a mock base worker for test.
MockBaseWorkerCheckSendMessage checks can receive one message from mock message sender.
MockBaseWorkerWaitUpdateStatus checks can receive a update status message from mock message sender.
MockMasterPrepareMeta simulates the meta persistence for MockMasterImpl.
MustConvertWorkerType2JobType return the job type of worker type.
NewBaseJobMaster creates a new DefaultBaseJobMaster instance.
NewBaseMaster creates a new DefaultBaseMaster instance.
NewBaseWorker creates a new BaseWorker instance.
NewMessageRouter creates a new MessageRouter.
NewMockMasterImpl creates a new MockMasterImpl instance.
WorkerStateToExitReason translates WorkerState to ExitReason TODO: business logic should not sense 'WorkerState'.

# Constants

define some ExitReason.
define some ExitReason.
define some ExitReason.
define some ExitReason.
Defines all reason codes.
Defines all reason codes.

# Structs

BaseWorkerForTesting mocks base worker.
DefaultBaseJobMaster implements BaseJobMaster interface.
DefaultBaseMaster implements BaseMaster interface.
DefaultBaseWorker implements BaseWorker interface, it also embeds an Impl which implements the WorkerImpl interface and passed from business logic.
MasterFailoverReason contains failover reason code and error message.
MessageRouter is a SPSC(single producer, single consumer) work model, since the message frequency is not high, we use a simple channel for message transit.
MockMasterImpl implements a mock MasterImpl.
MockWorkerHandler implements WorkerHandle, RunningHandle and TombstoneHandle interface.

# Interfaces

BaseJobMaster defines an interface that can work as a job master, it embeds a Worker interface which can run on dataflow engine runtime, and also provides some utility methods.
BaseJobMasterExt extends BaseJobMaster with some extra methods.
BaseMaster defines the master interface, it embeds the Master interface and contains more core logic of a master.
BaseWorker defines the worker interface, it embeds a Worker interface and adds more utility methods TODO: decouple the BaseWorker and WorkerService(for business).
JobMasterImpl is the implementation of a job master of dataflow engine.
Master defines a basic interface that can run in dataflow engine runtime.
MasterImpl defines the interface to implement a master, business logic can be added in the functions of this interface.
Worker defines an interface that provides all methods that will be used in runtime(runner container).
No description provided by the author
WorkerImpl is the implementation of a worker of dataflow engine.

# Type aliases

CreateWorkerOpt specifies an option for creating a worker.
ExitReason is the type for exit reason.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author