Package com.github.workerframework.api

Interface ManagedWorkerQueue

All Superinterfaces:

HealthReporter, WorkerQueue

All Known Implementing Classes:

RabbitWorkerQueue

public interface ManagedWorkerQueue
extends HealthReporter, WorkerQueue

A WorkerQueue for use at an application level, supporting management methods.

Method Summary

Modifier and Type	Method	Description
void	disconnectIncoming()	Disconnects the incoming queue so that no more tasks are consumed.
WorkerQueueMetricsReporter	getMetrics()
void	reconnectIncoming()	Reconnects the incoming queue so tasks consumption can resume.
void	shutdown()	Terminate all queue operations.
void	shutdownIncoming()	Halt the incoming queue so that no more tasks are picked up.
void	start(TaskCallback callback)	Open queues to start accepting tasks and results.

Methods inherited from interface com.github.cafapi.common.api.HealthReporter

healthCheck, livenessCheck

Methods inherited from interface com.github.workerframework.api.WorkerQueue

acknowledgeTask, discardTask, getInputQueue, getPausedQueue, publish, publish, rejectTask

Method Details

start

void start(TaskCallback callback)
    throws QueueException

Open queues to start accepting tasks and results.

Parameters:

callback - the callback to use when registering or aborting tasks

Throws:

QueueException - if the queue cannot be started

shutdownIncoming

void shutdownIncoming()

Halt the incoming queue so that no more tasks are picked up.

shutdown

void shutdown()

Terminate all queue operations.

getMetrics

WorkerQueueMetricsReporter getMetrics()

Returns:

the metrics implementation for this WorkerQueue

disconnectIncoming

void disconnectIncoming()

Disconnects the incoming queue so that no more tasks are consumed.

reconnectIncoming

void reconnectIncoming()

Reconnects the incoming queue so tasks consumption can resume.