SECTION 9 Auxiliary Functions

Functions
const char *	drmaa_strerror (int drmaa_errno)
int	drmaa_get_contact (char *contact, size_t contact_len, char *error_diagnosis, size_t error_diag_len)
int	drmaa_version (unsigned int *major, unsigned int *minor, char *error_diagnosis, size_t error_diag_len)
int	drmaa_get_DRM_system (char *drm_system, size_t drm_system_len, char *error_diagnosis, size_t error_diag_len)
int	drmaa_get_DRMAA_implementation (char *drmaa_impl, size_t drmaa_impl_len, char *error_diagnosis, size_t error_diag_len)
const char *	drmaa_gw_strstatus (int drmaa_state)

---

Function Documentation

int drmaa_get_contact	(	char *	contact,
		size_t	contact_len,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

If called before drmaa_init(), this function returns a string containing a comma-delimited list of default contact hosts for the GridWay daemon. If called after drmaa_init(), this funtion returns the contact string (hostname) where GridWay is running. The client library has been initialized by contacting this host.

Parameters:

	contact	The contact string(s)
	contact_len	The size in characters of the contact string buffer
	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.

int drmaa_get_DRM_system	(	char *	drm_system,
		size_t	drm_system_len,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function always returns "GridWay" in drm_system, the only DRM system supported by the GridWay DRMAA implementation

Parameters:

	drm_system	Always "GridWay"
	drm_system_len	The size in characters of the DRM system identifier buffer
	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.

int drmaa_get_DRMAA_implementation	(	char *	drmaa_impl,
		size_t	drmaa_impl_len,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function returns the DRMAA implementation. It always returns "DRMAA for GridWay M.m" where M is the GridWay major version number and m is the minor version number

Parameters:

	drmaa_impl	Always "DRMAA for GridWay M.m"
	drmaa_impl_len	The size in characters of the DRMAA implementation identifier buffer
	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.

const char* drmaa_gw_strstatus

(

int

drmaa_state

)

This function returns a state string describing the DRMAA state of a job. WARNING: THIS FUNCTION IS NOT PART OF DRMAA STANDARD DO NOT USE IT IN YOUR DRMAA CODES.

Parameters:

drmaa_state

The state of a job as obtained with the drmaa_ps() for which a string description is to be returned

const char* drmaa_strerror

(

int

drmaa_errno

)

This function returns the error string describing the DRMAA error number drmaa_errno

Parameters:

drmaa_errno

The error code for which a string description is to be returned

int drmaa_version	(	unsigned int *	major,
		unsigned int *	minor,
		char *	error_diagnosis,
		size_t	error_diag_len
	)

This function sets major and minor to the major and minor versions of the DRMAA C binding specification implemented by the DRMAA implementation. Current implementation is 1.0

Parameters:

	major	Major version number
	minor	Minor version number
	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.