Uses of Package
com.github.workerframework.api
Packages that use com.github.workerframework.api
Package
Description
-
Classes in com.github.workerframework.api used by com.github.workerframework.apiClassDescriptionThis object is supplied to CAF Workers which are able to process multiple tasks together.A representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes relevant to DataStore when it cannot handle a request.Provides metrics for a DataStore.The action to be taken by a worker when it receives a message that has been diverted.Indicates that a job task identifier, used in job tracking, has an invalid format.Indicates this task is fundamentally flawed in some manner, and is likely an error situation that would not be resolved through retrying.Job status returned by the status check URL.A DataStore with management methods for use within an application.A WorkerQueue for use at an application level, supporting management methods.Thrown by classes related to WorkerQueue when a request cannot be handled.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.The generic task message class to be serialised from or to a queue.Indicates that a task cannot be accepted right now, but that it should be retried at a later time.Records information about the agent that initiated a task message.The state of a worker thread upon termination.Holds fields used in tracking task messages, for Progress Reporting and Job Control.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.The callback interface for a task to report it is complete or that it must be subject to some further action, e.g.Thrown by classes related to Worker when a request cannot be handled.Instantiates a new instance of a Worker given task-specific data.A general representation of a queue for the purposes of a worker service.Provides metrics for a WorkerQueue.Object to represent a response from a Worker, to be interpreted by the core worker framework.Provides access onto Worker Task Data and ability to set response.Represents a task to be completed by the CAF Worker.
-
Classes in com.github.workerframework.api used by com.github.workerframework.cafClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Indicates this task is fundamentally flawed in some manner, and is likely an error situation that would not be resolved through retrying.Indicates that a task cannot be accepted right now, but that it should be retried at a later time.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.Thrown by classes related to Worker when a request cannot be handled.Instantiates a new instance of a Worker given task-specific data.Object to represent a response from a Worker, to be interpreted by the core worker framework.Provides access onto Worker Task Data and ability to set response.Represents a task to be completed by the CAF Worker.
-
Classes in com.github.workerframework.api used by com.github.workerframework.coreClassDescriptionThrown by classes relevant to DataStore when it cannot handle a request.Thrown by classes related to WorkerQueue when a request cannot be handled.Thrown by classes related to Worker when a request cannot be handled.
-
Classes in com.github.workerframework.api used by com.github.workerframework.datastores.fsClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes relevant to DataStore when it cannot handle a request.Provides metrics for a DataStore.Supported by
DataStoreimplementations which can supply an output stream for storing data.Simple boilerplate to return a DataStore implementation.An interface intended to be implemented by DataStores that support the concept of a unique filepath to each stored asset.A DataStore with management methods for use within an application. -
Classes in com.github.workerframework.api used by com.github.workerframework.datastores.httpClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes relevant to DataStore when it cannot handle a request.Provides metrics for a DataStore.Simple boilerplate to return a DataStore implementation.A DataStore with management methods for use within an application.Indicates the reference passed to the DataStore did not point to any resolvable location.
-
Classes in com.github.workerframework.api used by com.github.workerframework.datastores.memClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes relevant to DataStore when it cannot handle a request.Provides metrics for a DataStore.Simple boilerplate to return a DataStore implementation.A DataStore with management methods for use within an application.
-
Classes in com.github.workerframework.api used by com.github.workerframework.datastores.s3ClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes relevant to DataStore when it cannot handle a request.Provides metrics for a DataStore.Simple boilerplate to return a DataStore implementation.A DataStore with management methods for use within an application.
-
Classes in com.github.workerframework.api used by com.github.workerframework.queues.rabbitClassDescriptionA WorkerQueue for use at an application level, supporting management methods.Thrown by classes related to WorkerQueue when a request cannot be handled.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.A general representation of a queue for the purposes of a worker service.Provides metrics for a WorkerQueue.Boilerplate for retrieving a WorkerQueue implementation.
-
Classes in com.github.workerframework.api used by com.github.workerframework.testworkerClassDescriptionA representation of a generic data store, for reading and writing data typically used by workers in the course of their computation.Thrown by classes related to Worker when a request cannot be handled.Instantiates a new instance of a Worker given task-specific data.The responsibility of a WorkerFactory is to provide a mechanism to generate new Worker objects and specify how many simultaneous workers should be running.