Package org.opentcs.components.kernel.services

Interface PeripheralDispatcherService

public interface PeripheralDispatcherService

Provides methods concerning the PeripheralJobDispatcher.

Method Summary

Modifier and Type	Method	Description
void	dispatch()	Explicitly trigger the dispatching process for peripheral jobs.
void	withdrawByLocation(TCSResourceReference<Location> ref)	Withdraw any job that a peripheral device (represented by the given location) might be processing.
void	withdrawByPeripheralJob(TCSObjectReference<PeripheralJob> ref)	Withdraw the given peripheral job.

Method Details

dispatch

void dispatch() throws KernelRuntimeException

Explicitly trigger the dispatching process for peripheral jobs.

If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

Throws:

KernelRuntimeException - In case there is an exception executing this method.

withdrawByLocation

void withdrawByLocation(TCSResourceReference<Location> ref) throws ObjectUnknownException, KernelRuntimeException

Withdraw any job that a peripheral device (represented by the given location) might be processing.

If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

Parameters:

ref - A reference to the location representing the peripheral device.

Throws:

ObjectUnknownException - If the referenced location does not exist.

KernelRuntimeException - In case there is an exception executing this method.

withdrawByPeripheralJob

void withdrawByPeripheralJob(TCSObjectReference<PeripheralJob> ref) throws ObjectUnknownException, KernelRuntimeException

Withdraw the given peripheral job.

If called within the kernel application, this method is supposed to be called only on the kernel executor thread.

Parameters:

ref - A reference to the peripheral job to be withdrawn.

Throws:

ObjectUnknownException - If the referenced peripheral job does not exist.

KernelRuntimeException - In case there is an exception executing this method.