OmeroBlitz API

omero::grid::Processor

Overview

[ "ami" ] interface Processor

Simple controller for Processes. Uses the session id given to create an Ice.Config file which is used as the sole argument to an execution of the given job. Jobs are responsible for loading arguments from the environment via the session id.

Operation Index

willAccept

Called by SharedResources to find a suitable target for {@code omero.grid.SharedResources.acquireProcessor}.

requestRunning

Used by servers to find out what jobs are still active.

parseJob

Parses a job and returns metadata definition required for properly submitting the job.

processJob

Starts a process based on the given job If this processor cannot handle the given job, a null process will be returned.

Operations

void willAccept(model::Experimenter userContext, model::ExperimenterGroup groupContext, model::Job scriptContext, ProcessorCallback* cb)

Called by SharedResources to find a suitable target for {@code omero.grid.SharedResources.acquireProcessor}. New processor instances are added to the checklist by using {@code omero.grid.SharedResources.addProcessor}. All processors must respond with their session uuid in order to authorize the action.

void requestRunning(ProcessorCallback* cb)

Used by servers to find out what jobs are still active. Response will be sent to {@code ProcessorCallback.responseRunning}

JobParams parseJob(string session, model::Job jobObject) throws ServerError

Parses a job and returns metadata definition required for properly submitting the job. This object will be cached by the server, and passed back into {@code processJob}

Process* processJob(string session, JobParams params, model::Job jobObject) throws ServerError

Starts a process based on the given job If this processor cannot handle the given job, a null process will be returned. The {@code params} argument was created by a previously call to {@code parseJob}.