.::GridWay::.

int drmaa_synchronize	(	const char *	job_ids[],
		signed long	timeout,
		int	dispose,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function blocks until all jobs specified by job_ids have completed execution or fail.

Parameters:

	*job_ids[]	A NULL terminated list of jobid strings. The jobids SHOULD be obtained from a drmaa_run_job() or drmaa_run_bulk_jobs() function calls. The pre-defined value DRMAA_JOB_IDS_SESSION_ALL can be used to synchronize all jobs submitted during the DRMAA session. Please note that "disposed" jobs will be removed from the job-list associated to the DRMAA session.
	timeout	specifies the time elapsed before the function call returns. DRMAA_TIMEOUT_WAIT_FOREVER can be used to wait indefinitely for a result. The value DRMAA_TIMEOUT_NO_WAIT returns immediately if no result is available. Alternatively, a number of seconds can be specified.
	dispose	If dispose is equal to 1 the jobid will be killed, and its resources freed in the GridWay system. Therefore subsequent calls on this job will fail. However, if dispose is equal to 0 the job remains in DRMAA_PS_DONE state in the GridWay system and its rusage statistics can be obtained with drmaa_wait() function call. Also these jobid will not make subsequent calls to drmaa_synchronize() function call to fail.
	error_diagnosis	string of characters with error related diagnosis information. The error diagnosis buffer will be filled in case of error. If the size of error_diagnosis buffer passed is smaller than the error message the resultant string will be truncated.
	error_diag_len	size of the error_diagnosis buffer. DRMAA_ERROR_STRING_BUFFER can be used for error_diag_len when appropiate.

Returns:

DRMAA_ERRNO_SUCCESS on success.
DRMAA_ERRNO_INVALID_ARGUMENT if timeout is not DRMAA_TIMEOUT_WAIT_FOREVER
DRMAA_ERRNO_INVALID_JOB the job does not exist or has already been reaped
DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE could not contact GridWay
DRMAA_ERRNO_NO_ACTIVE_SESSION if drmaa_init() function has not been previously called.

int drmaa_wait	(	const char *	job_id,
		char *	job_id_out,
		size_t	job_id_out_len,
		int *	stat,
		signed long	timeout,
		drmaa_attr_values_t **	rusage,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function waits for a given job to either finish executing or fail. If successfully waited, the jobs rusage information has been reaped, and further calls to drmaa_wait() with this job_id will return DRMAA_ERRNO_INVALID_JOB.

Parameters:

	*job_id	String with the job unique identification as provided by the GridWay system. The jobid SHOULD be obtained from a drmaa_run_job() or drmaa_run_bulk_jobs() function calls. DRMAA_JOB_IDS_SESSION_ANY can be used to wait on any job submitted during the DRMAA session. Please note that "disposed" jobs will be removed from the job-list associated to the DRMAA session.
	job_id_out	String that holds the job unique identification of the job that finished its execution, up to job_id_out_len characters. job_id_out string SHOULD be of size DRMAA_GW_JOBID_BUFFER
	job_id_out_len	size of the job_id_out buffer. DRMAA_GW_JOBID_BUFFER SHOULD be used for job_id_out_len.
	stat	The exit status of job job_id_out. It can be interpreted with the drmaa_wifexited(), drmaa_wexitstatus(), drmaa_wifsignaled() and drmaa_wtermsig().
	timeout	specifies the time elapsed before the function call returns. DRMAA_TIMEOUT_WAIT_FOREVER can be used to wait indefinitely for a result. The value DRMAA_TIMEOUT_NO_WAIT returns immediately if no result is available. Alternatively, a number of seconds can be specified.
	**rusage	Array of values with the remote resource usage made by job job_id_out. The GridWay DRMAA implementation provides the following strings: "start_time=HH:MM:SS" The time the job entered the GridWay system. "exit_time=HH:MM:SS" The time the job completed its execution, i.e. entered DRMAA_PS_DONE or DRMAA_PS_FAILED state. "cpu_time=HH:MM:SS" Overall execution time on remote host. "xfr_time=HH:MM:SS" Overall file transfer time (stge-in + stage-out) rusage values can be access with the drmaa_get_netxt_attr_values() function call. rusage memory MUST be de-allocated by calling drmaa_release_attr_values().
	error_diagnosis	string of characters with error related diagnosis information. The error diagnosis buffer will be filled in case of error. If the size of error_diagnosis buffer passed is smaller than the error message the resultant string will be truncated.
	error_diag_len	size of the error_diagnosis buffer. DRMAA_ERROR_STRING_BUFFER can be used for error_diag_len when appropiate.

Returns:

DRMAA_ERRNO_SUCCESS on success.
DRMAA_ERRNO_INVALID_ARGUMENT if timeout is not DRMAA_TIMEOUT_WAIT_FOREVER or job_id_out is NULL
DRMAA_ERRNO_INVALID_JOB the job does not exist or has already been reaped
DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE could not contact GridWay
DRMAA_ERRNO_NO_RUSAGE the job has been killed and no usage is available for this job.
DRMAA_ERRNO_NO_ACTIVE_SESSION if drmaa_init() function has not been previously called.


Functions
int	drmaa_synchronize (const char job_ids[], signed long timeout, int dispose, char error_diagnosis, size_t error_diag_len)
int	drmaa_wait (const char job_id, char job_id_out, size_t job_id_out_len, int stat, signed long timeout, drmaa_attr_values_t rusage, char error_diagnosis, size_t error_diag_len)

SECTION 7 Job Synchronize and Wait Functions

Functions

Function Documentation