.::GridWay::.

int drmaa_allocate_job_template	(	drmaa_job_template_t **	jt,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function allocates a new job template. This template is used to describe the job to be submitted. This is accomplished by setting the desired scalar and vector attributes to their appropriate values.

Parameters:

	jt	Reference to a job template pointer. The DRMAA API runtime library will allocate memory for the new template. This memory MUST be freed with a subsequent call to drmaa_delete_job_template() function
	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_NO_ACTIVE_SESSION no active session
DRMAA_ERRNO_INTERNAL_ERROR unexpected error
DRMAA_ERRNO_NO_MEMORY if there is not enough system memory to allocate the job template.

int drmaa_delete_job_template	(	drmaa_job_template_t *	jt,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function deallocates a job template.

Parameters:

	jt	Pointer to a job_template structure. The job template *jt MUST BE previously allocated with a drmaa_allocate_job_template() function call.
	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_NO_ACTIVE_SESSION no active session

int drmaa_get_attribute	(	drmaa_job_template_t *	jt,
		const char *	name,
		char *	value,
		size_t	value_len,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function returns the value of a given attribute name. If the attribute name is not defined in the GridWay system an empty string will be returned with exit code DRMAA_ERRNO_INVALID_ARGUMENT.

Parameters:

	jt	Pointer to a job_template structure. The job template *jt MUST BE previously allocated with a drmaa_allocate_job_template() function call.
	name	Name of the job template attribute to be set.
	value	Value associated to the given attribute name.
	value_len	size of the attribute value buffer. The pre-defined
	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:

On success value will hold the value of the specified attribute name up to value_len characters.

DRMAA_ERRNO_SUCCESS on success
DRMAA_ERRNO_INVALID_ARGUMENT if name, value or jt are NULL, or value_len is 0. Also if attribute name is not defined by GridWay.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_get_attribute_names	(	drmaa_attr_names_t **	values,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function returns the set of supported scalar attribute names by the GridWay DRMAA implementation.

Parameters:

	values	The string vector containing the attribute names
	error_diagnosis	string of characters with error related diagnosis information.
	error_diag_len	size of the error_diagnosis buffer.

Returns:

DRMAA_ERRNO_SUCCESS on success.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_get_vector_attribute	(	drmaa_job_template_t *	jt,
		const char *	name,
		drmaa_attr_values_t **	values,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function stores in values a values string vector containing the values of the vector attribute, name's value in the given job template. If the attribute name is not defined in the GridWay system vector with an empty string will be returned i.e. {'\0',NULL}.

Parameters:

	jt	Pointer to a job_template structure. The job template *jt MUST BE previously allocated with a drmaa_allocate_job_template() function call.
	name	Name of the job attribute whose values will be retrieved.
	values	A opaque string vector containing the attribute 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 jt or name are NULL, or attribute name is not defined by GridWay.
DRMAA_ERRNO_NO_MEMORY if there is not enough system memory to allocate the values list.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_get_vector_attribute_names	(	drmaa_attr_names_t **	values,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function returns the set of supported vector attribute names by the GridWay DRMAA implementation.

Parameters:

	values	The string vector containing the vector attribute names
	error_diagnosis	string of characters with error related diagnosis information.
	error_diag_len	size of the error_diagnosis buffer.

Returns:

DRMAA_ERRNO_SUCCESS on success.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_set_attribute	(	drmaa_job_template_t *	jt,
		const char *	name,
		const char *	value,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

The function drmaa_set_attribute() sets an scalar attribute to a given value. Attribute names should be instantiated we the pre-defined attribute names. Several calls to drmaa_set_attribute() with the same attribute name will override its value.

Parameters:

	jt	Pointer to a job_template structure. The job template *jt MUST BE previously allocated with a drmaa_allocate_job_template() function call.
	name	Name of the job template attribute to be set.
	value	Value associated to the given attribute name.
	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 jt, name or value are NULL or the attribute name is not defined by GridWay.
DRMAA_ERRNO_NO_MEMORY if there is not enough system memory to allocate a string to store the value in the job template.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_set_vector_attribute	(	drmaa_job_template_t *	jt,
		const char *	name,
		const char *	value[],
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function sets an attribute to a given vector value. Vector attribute names should be instantiated we the pre-defined vector attribute names. Several calls to drmaa_set_vector_attribute() with the same attribute name will override its value.

Parameters:

	jt	Pointer to a job_template structure. The job template *jt MUST BE previously allocated with a drmaa_allocate_job_template() function call.
	name	Name of the job template attribute to be set. The name buffer should be of length DRMAA_ATTR_BUFFER.
	value[]	A NULL terminated list of 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 name, value or jt are NULL, or attribute is a scalar or not defined by GridWay
DRMAA_ERRNO_NO_MEMORY if there is not enough system memory to allocate the vector values.
DRMAA_ERRNO_NO_ACTIVE_SESSION no active session


Functions
int	drmaa_allocate_job_template (drmaa_job_template_t *jt, char error_diagnosis, size_t error_diag_len)
int	drmaa_delete_job_template (drmaa_job_template_t jt, char error_diagnosis, size_t error_diag_len)
int	drmaa_set_attribute (drmaa_job_template_t jt, const char name, const char value, char error_diagnosis, size_t error_diag_len)
int	drmaa_get_attribute (drmaa_job_template_t jt, const char name, char value, size_t value_len, char error_diagnosis, size_t error_diag_len)
int	drmaa_set_vector_attribute (drmaa_job_template_t jt, const char name, const char value[], char error_diagnosis, size_t error_diag_len)
int	drmaa_get_vector_attribute (drmaa_job_template_t jt, const char name, drmaa_attr_values_t *values, char error_diagnosis, size_t error_diag_len)
int	drmaa_get_attribute_names (drmaa_attr_names_t *values, char error_diagnosis, size_t error_diag_len)
int	drmaa_get_vector_attribute_names (drmaa_attr_names_t *values, char error_diagnosis, size_t error_diag_len)

SECTION 4 Job Template Functions

Functions

Function Documentation