plugin

type BaseJob struct {
	*BasePlugin
	// contains filtered or unexported fields
}

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

type BasePlugin struct {
	*BasePluggable
}

type BaseTask struct {
	*BasePlugin
	// contains filtered or unexported fields
}

type Job interface {
	Plugin
	// Job ID - a unique identifier for a job
	JobID() int64
	// Set Job ID - a function or method to set the ID of a job
	SetJobID(jobID int64)
	Collector() JobCollector   // todo - The job collector is currently not in use
	SetCollector(JobCollector) // todo - The function or method to set the job collector is currently not in use
}

type JobCollector interface {
	JSON() *encoding.JSON
	JSONByKey(key string) *encoding.JSON
}

type Pluggable interface {
	// Plugin Developer, generally written in the plugin configuration
	Developer() (string, error)
	// Plugin Description, generally written in the plugin configuration
	Description() (string, error)
	// Plugin Name, generally written in the plugin configuration
	PluginName() (string, error)
	/* Plugin Configuration, basic configuration is as follows, the rest can be customized according to individual needs
	{
		"name" : "mysqlreader",
		"developer":"Breeze0806",
		"description":"use github.com/go-sql-driver/mysql. database/sql DB execute select sql, retrieve data from the ResultSet. warn: The more you know about the database, the less problems you encounter."
	}
	*/
	PluginConf() *config.JSON
	// Plugin Working Configuration
	PluginJobConf() *config.JSON
	// Corresponding Plugin Name (for Writer, it's Reader; for Reader, it's Writer)
	PeerPluginName() string
	// Corresponding Plugin Configuration (for Writer, it's Reader; for Reader, it's Writer)
	PeerPluginJobConf() *config.JSON
	// Set Working Plugin
	SetPluginJobConf(conf *config.JSON)
	// Set Corresponding Plugin Configuration (for Writer, it's Reader; for Reader, it's Writer)
	SetPeerPluginJobConf(conf *config.JSON)
	// Set Corresponding Plugin Name (for Writer, it's Reader; for Reader, it's Writer)
	SetPeerPluginName(name string)
	// Set Plugin Configuration
	SetPluginConf(conf *config.JSON)
	// Initialize Plugin, needs to be implemented by the implementer according to their needs
	Init(ctx context.Context) error
	// Destroy Plugin, needs to be implemented by the implementer according to their needs
	Destroy(ctx context.Context) error
}

type Plugin interface {
	Pluggable
	// PreCheck - a pre-processing check or verification step
	PreCheck(ctx context.Context) error
	// Prepare - a preparation step before the main operation
	Prepare(ctx context.Context) error
	// PostNotification - a notification step after the main operation
	Post(ctx context.Context) error
	// PreHandler - preprocessing, todo - currently not in use
	PreHandler(ctx context.Context, conf *config.JSON) error
	// PostHandler - post-notification processing, todo - currently not in use
	PostHandler(ctx context.Context, conf *config.JSON) error
}

type RecordReceiver interface {
	GetFromReader() (element.Record, error) // Reads records from the reader
	Shutdown() error                        // Closes the receiver
}

type RecordSender interface {
	CreateRecord() (element.Record, error)  // Create Record
	SendWriter(record element.Record) error // Send Record to Writer
	Flush() error                           // Refresh Record to Record Sender
	Terminate() error                       // Terminate Transmission Signal
	Shutdown() error                        // Close
}

type Task interface {
	Plugin

	// Task Information Collector, todo - not currently used
	TaskCollector() TaskCollector
	// Set Task Information Collector, todo - not currently used
	SetTaskCollector(collector TaskCollector)

	// Job ID
	JobID() int64
	// Set Job ID
	SetJobID(jobID int64)
	// Task Group ID
	TaskGroupID() int64
	// Set Task Group ID
	SetTaskGroupID(taskGroupID int64)
	// Task ID
	TaskID() int64
	// Set Task ID
	SetTaskID(taskID int64)
	// Wrap Error
	Wrapf(err error, format string, args ...any) error
	// Format - Log format
	Format(format string) string
}

type TaskCollector interface {
	CollectDirtyRecordWithError(record element.Record, err error)
	CollectDirtyRecordWithMsg(record element.Record, msgErr string)
	CollectDirtyRecord(record element.Record, err error, msgErr string)
	CollectMessage(key string, value string)
}

type Type string