DRMAA interface. –
Modules
Vector iteration functions.
The drmaa_get_next_X() functions SHALL store up to
value_len bytes of the next attribute name / attribute value / job identifier from the
values opaque string vector in the
value buffer.
Job template operations.
The function drmaa_allocate_job_template() SHALL allocate a new job template, returned in jt.
Functions
int
drmaa_init (const char *contact, char *error_diagnosis, size_t error_diag_len)
The drmaa_init() function SHALL initialize DRMAA library and create a new DRMAA session, using the contact parameter, if provided, to determine to which DRMS to connect.
int
drmaa_exit (char *error_diagnosis, size_t error_diag_len)
The drmaa_exit() function SHALL disengage from DRMAA library and allow the DRMAA library to perform any necessary internal cleanup.
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)
The function drmaa_get_attribute() SHALL fill the
value buffer with up to
value_len characters of the scalar attribute,
name’s, value in the given job template.
int
drmaa_set_vector_attribute (
drmaa_job_template_t *jt, const char *name, const char *value[], char *error_diagnosis, size_t error_diag_len)
The function drmaa_set_vector_attribute() SHALL set the vector attribute,
name, in the job template,
jt, to the value(s),
value.
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)
The function drmaa_get_vector_attribute() SHALL store in
values an opaque values string vector containing the values of the vector attribute,
name’s, value in the given job template.
int
drmaa_get_attribute_names (
drmaa_attr_names_t **values, char *error_diagnosis, size_t error_diag_len)
The function drmaa_get_attribute_names() SHALL return the set of supported scalar attribute names in an opaque names string vector stored in
values.
int
drmaa_get_vector_attribute_names (
drmaa_attr_names_t **values, char *error_diagnosis, size_t error_diag_len)
The function drmaa_get_vector_attribute_names() SHALL return the set of supported vector attribute names in an opaque names string vector stored in
values.
Detailed Description
Function Documentation
int drmaa_init (const char *contact, char *error_diagnosis, size_terror_diag_len)
The
drmaa_init() function SHALL initialize DRMAA library and create a new DRMAA session, using the contact parameter, if provided, to determine to which DRMS to connect. This function MUST be called before any other DRMAA function, except for
drmaa_get_DRM_system(),
drmaa_get_DRMAA_implementation(),
drmaa_get_contact(), and
drmaa_strerror(). If
contact is NULL, the default DRM system SHALL be used, provided there is only one DRMAA implementation in the provided binary module. When there is more than one DRMAA implementation in the binary module,
drmaa_init() SHALL return the DRMAA_ERRNO_NO_DEFAULT_CONTACT_STRING_SELECTED error code. The
drmaa_init() function SHOULD be called by only one of the threads. The main thread is RECOMMENDED. A call by another thread SHALL return the DRMAA_ERRNO_ALREADY_ACTIVE_SESSION error code.
int drmaa_exit (char *error_diagnosis, size_terror_diag_len)
The
drmaa_exit() function SHALL disengage from DRMAA library and allow the DRMAA library to perform any necessary internal cleanup. This routine SHALL end the current DRMAA session but SHALL NOT affect any jobs (e.g, queued and running jobs SHALL remain queued and running).
drmaa_exit() SHOULD be called by only one of the threads. The first call to call
drmaa_exit() by a thread will operate normally. All other calls from the same and other threads SHALL fail, returning a DRMAA_ERRNO_NO_ACTIVE_SESSION error code.
int drmaa_set_vector_attribute (drmaa_job_template_t *jt, const char *name, const char *value[], char *error_diagnosis, size_terror_diag_len)
The function
drmaa_set_vector_attribute() SHALL set the vector attribute,
name, in the job template,
jt, to the value(s),
value. The DRMAA implementation MUST accept value values that are arrays of one or more strings terminated by a NULL entry.
int drmaa_get_attribute_names (drmaa_attr_names_t **values, char *error_diagnosis, size_terror_diag_len)
The function
drmaa_get_attribute_names() SHALL return the set of supported scalar attribute names in an opaque names string vector stored in
values. This vector SHALL include all required scalar attributes, all supported optional scalar attributes, all DRM-specific scalar attributes, and no unsupported optional attributes.
int drmaa_get_vector_attribute_names (drmaa_attr_names_t **values, char *error_diagnosis, size_terror_diag_len)
The function
drmaa_get_vector_attribute_names() SHALL return the set of supported vector attribute names in an opaque names string vector stored in
values. This vector SHALL include all required vector attributes, all supported optional vector attributes, all DRM-specific vector attributes, and no unsupported optional attributes.
Author
Generated automatically by Doxygen for torque from the source code.
