Package com.github.workerframework.api

package com.github.workerframework.api

Class	Description
BulkWorker	This interface should be implemented by CAF Workers which are able to process multiple tasks together.
BulkWorkerRuntime	This object is supplied to CAF Workers which are able to process multiple tasks together.
DataStore	A representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.
DataStoreException	Thrown by classes relevant to DataStore when it cannot handle a request.
DataStoreMetricsReporter	Provides metrics for a DataStore.
DataStoreOutputStreamSupport	Supported by DataStore implementations which can supply an output stream for storing data.
DataStoreProvider	Simple boilerplate to return a DataStore implementation.
DataStoreSource	An implementation of a DataSource that uses a Worker DataStore and a CAF Codec.
DivertedTaskAction	The action to be taken by a worker when it receives a message that has been diverted.
DivertedTaskHandler	A worker should implement this interface if it is capable of evaluating task messages that have been diverted (maybe because the worker's input queue is different from the target/to queue in the task message), and deciding what to do with them.
FilePathProvider	An interface intended to be implemented by DataStores that support the concept of a unique filepath to each stored asset.
InvalidJobTaskIdException	Indicates that a job task identifier, used in job tracking, has an invalid format.
InvalidTaskException	Indicates this task is fundamentally flawed in some manner, and is likely an error situation that would not be resolved through retrying.
JobNotFoundException	Indicates that a job has not been found.
JobStatus	Job status returned by the status check URL.
ManagedDataStore	A DataStore with management methods for use within an application.
ManagedWorkerQueue	A WorkerQueue for use at an application level, supporting management methods.
QueueException	Thrown by classes related to WorkerQueue when a request cannot be handled.
ReferenceNotFoundException	Indicates the reference passed to the DataStore did not point to any resolvable location.
TaskCallback	A callback interface used to announce the arrival of a new task for a worker to process or signal that the core should cancel its tasks.
TaskFailedException	An unchecked exception to throw if a Worker fails its task in an unrecoverable way.
TaskInformation
TaskMessage	The generic task message class to be serialised from or to a queue.
TaskMessageForwardingEvaluator	Deprecated. This interface is limited in the arguments the determineForwardingAction method takes, and the fact that it can only return void.
TaskRejectedException	Indicates that a task cannot be accepted right now, but that it should be retried at a later time.
TaskSourceInfo	Records information about the agent that initiated a task message.
TaskStatus	The state of a worker thread upon termination.
TrackingInfo	Holds fields used in tracking task messages, for Progress Reporting and Job Control.
Worker	A Worker can be constructed in any way as per suits the developer, but should only perform the bare minimum of tasks in the constructor to set itself up to perform the computational work.
WorkerCallback	The callback interface for a task to report it is complete or that it must be subject to some further action, e.g.
WorkerConfiguration
WorkerException	Thrown by classes related to Worker when a request cannot be handled.
WorkerFactory	Instantiates a new instance of a Worker given task-specific data.
WorkerFactoryProvider	The responsibility of a WorkerFactory is to provide a mechanism to generate new Worker objects and specify how many simultaneous workers should be running.
WorkerQueue	A general representation of a queue for the purposes of a worker service.
WorkerQueueMetricsReporter	Provides metrics for a WorkerQueue.
WorkerQueueProvider	Boilerplate for retrieving a WorkerQueue implementation.
WorkerResponse	Object to represent a response from a Worker, to be interpreted by the core worker framework.
WorkerTask	Provides access onto Worker Task Data and ability to set response.
WorkerTaskData	Represents a task to be completed by the CAF Worker.