OmeroBlitz API

omero::grid::InteractiveProcessor

Overview

[ "ami" ] interface InteractiveProcessor

Client facing interface to the background processing framework. If a user needs interactivity, one of these processors should be acquired from the ServiceFactory. Otherwise, a Job can be submitted via JobHandle.

Operation Index

expires

Returns the system clock time in milliseconds since the epoch at which this processor will be reaped.

getJob

Returns the job which defines this processor.

params

Retrieves the parameters needed to be passed in an execution and the results which will be passed back out.

execute

Executes an instance of the job returned by getJob() using the given map as inputs.

getResults

Retrieve the results for the given process.

setDetach

Sets whether or not cancel will be called on the current Process on stop.

stop

Clears the current execution of model::Job from the processor to prepare for another execution.

Operations

long expires()

model::Job getJob()

Returns the job which defines this processor. This may be only the last job associated with the processor if execute is called multiple times.

JobParams params() throws ServerError

Retrieves the parameters needed to be passed in an execution and the results which will be passed back out. This method is guaranteed to return a non-null value or throw an exception.

Process* execute(RMap inputs) throws ServerError

Executes an instance of the job returned by getJob() using the given map as inputs.

RMap getResults(Process* proc) throws ServerError

Retrieve the results for the given process. This will throw an ApiUsageException if called before the process has returned. Use either process.poll() or process.wait() or a ProcessCallback to wait for completion before calling. If the user has not overridden or disabled the output values "stdout" and "stderr", these will be filled with the OriginalFile instances uploaded after completion under the key values of the same name.

bool setDetach(bool detach) throws ServerError

Sets whether or not cancel will be called on the current Process on stop. If detach is true, then the Process will continue running. Otherwise, Process::cancel will be called, before preparing for another run. false by default

void stop() throws ServerError

Clears the current execution of model::Job from the processor to prepare for another execution. cancel() will be called on the current Process if detach is set to false.