worker

type Client interface {
	// Submit sends a payload to be processed by the task handler registered with the specified pattern.
	// The task will be executed immediately if it matches the pattern.
	//
	// It returns an error if the pattern is invalid or if there is an issue submitting the task.
	Submit(ctx context.Context, pattern TaskPattern, payload []byte) error
	// SubmitToBatch sends a payload to be added to a batch for processing. The task handler registered with
	// the specified pattern will process the batch either when a series of payloads have been enqueued
	// or when the specified time delay is reached.
	//
	// It returns an error if the pattern is invalid or if there is an issue submitting the task to the batch.
	SubmitToBatch(ctx context.Context, pattern TaskPattern, payload []byte) error
	// Close closes the client's connection.
	Close() error
}

type CronHandler func(ctx context.Context) error

type CronSpec string

type Cronjob struct {
	// Identifier is a UUID for the cron job, used internally to register the task with the
	// scheduler.
	Identifier string
	// Spec is the cron expression that defines the schedule for the cron job.
	Spec CronSpec
	// Handler is the callback function that will be executed when the cron specification is met.
	Handler CronHandler
	// Unique defines whether the task cannot be perfomed concurrently.
	Unique bool
}

type CronjobOption func(c *Cronjob)

type Server interface {
	// HandleTask registers a task with the provided pattern. The task will be executed
	// every time a client enqueues a payload matching the pattern. Batch tasks will be executed
	// when the client enqueues a series of payloads or when the specified time delay is reached.
	//
	// It panics if the pattern is invalid. Batch tasks are specified in options.
	HandleTask(pattern TaskPattern, cb TaskHandler, opts ...TaskOption)
	// HandleCron executes the cronFunc every time the cron specification is met.
	//
	// It panics if the cron specification is invalid.
	HandleCron(spec CronSpec, cronFunc CronHandler, opts ...CronjobOption)
	// Start initializes and starts the worker in a non-blocking manner. The server is
	// turned off whedn the context was done.
	//
	// It returns an error if any issues occur during the startup process.
	Start() error
	// Shutdown gracefully shuts down the server.
	Shutdown()
}

type Task struct {
	// Pattern is a string to which the task can listen to message/events.
	Pattern TaskPattern
	// Handler is the callback that the task will execute when receiving messages/events.
	Handler TaskHandler
}

type TaskHandler func(ctx context.Context, payload []byte) error

type TaskOption func(t *Task)

type TaskPattern string