globus_gram_job_manager_script_interface(3) [debian man page]
globus_gram_job_manager_script_interface(3) globus gram job manager globus_gram_job_manager_script_interface(3) NAME
globus_gram_job_manager_script_interface - Job Manager Scheduler Interface The GRAM Job Manager interfaces with the job filesystems and scheduler through scheduler-specific Perl modules. GRAM provides several Perl modules which can be used to implement scheduler-specific interfaces to the GRAM Job Manager. These are: Globus::GRAM::Error This module implements the GRAM error results as objects. Methods in this module will construct a GRAM error with the value matching the values in the GRAM Protocol library. A scheduler-specific JobManager module may return one of these objects from its methods to indicate errors to the Job Manager program. Globus::GRAM::JobState This module defines the GRAM job state constants. A scheduler-specific JobManager module returns one of these values from its methods to indicate the managed job's current state. Globus::GRAM::JobSignal This module defines the GRAM job signal constant values. The Job Manager uses these values to communicate which signal is being invoked in the manager's signal method. Globus::GRAM::JobManager This module defines the actual implementatoin of the Job Manager scheduler interface. One writing a scheduler-specific GRAM interface will create a subclass of this object which overrides the default implementation's methods. Globus::GRAM::JobDescription This module mimics the RSL job description using perl syntax. The job manager passes an object of this type to the JobManager modules's constructor. The job manager stores RSL and some configuration values in that JobDescription object. The manager accesses values stored in the JobDescription by invoking methods containing the RSL attribute's name (example: $description->gram_my_job()). Method names are handled as if they were based on the canonical RSL representation of the attribute name. For example, the gram_my_job may be equivalently referred to as GramMyJob, grammyjob, or GRAM_My_Job. Version 13.33 Mon Apr 30 2012 globus_gram_job_manager_script_interface(3)
Check Out this Related Man Page
Other GRAM Client Functions(3) globus gram client Other GRAM Client Functions(3) NAME
Other GRAM Client Functions - Functions void globus_gram_client_debug (void) int globus_gram_client_version (void) int globus_gram_client_set_credentials (gss_cred_id_t new_credentials) const char * globus_gram_client_error_string (int error_code) int globus_gram_client_job_contact_free (char *job_contact) void globus_gram_client_job_info_destroy (globus_gram_client_job_info_t *info) Function Documentation void globus_gram_client_debug (void) Enable GRAM debugging. The globus_gram_client_debug() function enables the displaying of internal GRAM debug messages to standard output. Most of the information printed by this debugging system is related to errors that occur during GRAM Client API functions. The messages printed to standard output are not structured in any way. Returns: void int globus_gram_client_version (void) Return GRAM protocol version. The globus_gram_client_version() function returns the version of the GRAM protocol understood by this implementation. Returns: The integer protocol revision. int globus_gram_client_set_credentials (gss_cred_id_tnew_credentials) Set the default GRAM credential. The globus_gram_client_set_credentials() function causes subsequent GRAM operations to use the GSSAPI credential new_credentials. These operations include job requests, job signals, callback registration, and job state callbacks. After this function returns, the caller must not use the credential, as it may be freed by GRAM when it is no longer needed. Parameters: new_credentials New GSSAPI credential to use. Returns: Upon success, globus_gram_client_set_credentials() returns GLOBUS_SUCCESS. There are no error values returned by this fucntion. Return values: GLOBUS_SUCCESS Success const char* globus_gram_client_error_string (interror_code) Get a description of a a GRAM error code. The globus_gram_client_error_string() function takes a GRAM error code value and returns the associated error code string. The string is statically allocated by the Globus GRAM Client library and should not be modified or freed. The string is intended to complete a sentence of the form '[operation] failed because ...' Parameters: error_code The error code to translate into a string. Returns: The globus_gram_client_error_string() function returns a static string containing an explanation of the error. int globus_gram_client_job_contact_free (char *job_contact) Releases the resources storing a job contact string. Parameters: job_contact A job contact string returned in a successful call to globus_gram_client_job_request() Free a job contact string The globus_gram_client_job_contact_free() function frees a job contact string that was allocated by a call to one of the functions in the globus_gram_client_job_request() family. The free() function can be used in place of this function. After this function returns, the string pointed to by the job_contact parameter has an undefined value. Parameters: job_contact Pointer to a job contact string returned by a GRAM client API function. Returns: This function always returns GLOBUS_SUCCESS. Return values: GLOBUS_SUCCESS Success void globus_gram_client_job_info_destroy (globus_gram_client_job_info_t *info) Free memory associated with a globus_gram_client_job_info_t structure. The globus_gram_client_job_info_destroy() function frees data pointed to by the extensions and job_contact fields of the globus_gram_client_job_info_t structure pointed to by the info parameter. Parameters: info A structure containing data to free. Author Generated automatically by Doxygen for globus gram client from the source code. Version 12.4 Mon Apr 30 2012 Other GRAM Client Functions(3)