1. drmaa2_j_hold(3)
  2. DRMAA2
  3. drmaa2_j_hold(3)


drmaa2_j_hold - drmaa2_j_hold, Adds a user hold to a job.


#include "drmaa2.h"

drmaa2_error drmaa2_j_hold(drmaa2_j job);


Sets a user hold from to the given job. The job must be valid and the job session the job was submitted in must be open. If the job was not scheduled before the hold state was set, the job stays waiting until it is explicitly released by dmraa2_j_release(3). Setting a user hold and releasing the job from the hold state is equivalent the Univa(R) Grid Engine(TM) command line commands qhold -h u and qrls -h u. Note that operator and system holds can not be set by this function.

Note that triggering resume is asynchronous. That means that the call does not block until the job state transistion is reported back from the Univa(R) Grid Engine(TM) master process. Hence a following drmaa2_j_get_state(3) can still see the job as beeing suspended. The state change is visiable as soon as the Univa(R) Grid Engine(TM) master process reports the new state to the application in the background of a job or monitoring session.


Returns DRMAA2_SUCCESS in case of success otherwise the error ID indicating the problem is returnd. In case of an error the text description of the error is stored in the context of the calling thread and can be read out with the drmaa2_geterror_text(3) function.


drmaa2_geterror_text(3), drmaa2_j_suspend(3), drmaa2_j_resume(3), drmaa2_j_hold(3), drmaa2_j_release(3), drmaa2_j_terminate(3), drmaa2_j_get_id(3), drmaa2_j_get_session_name(3), drmaa2_j_get_jt(3), drmaa2_j_get_state(3), drmaa2_j_get_info(3), drmaa2_j_wait_started(3), drmaa2_j_wait_terminated(3), drmaa2_jsession_run_job(3), drmaa2_j_free(3), qhold(3), qrls(3)


Copyright Univa Corporation 2013

  1. Univa Corporation
  2. October 2013
  3. drmaa2_j_hold(3)