Page Comparison

  
namespace drmaa2 {

typedef long TimeAmount;
typedef time_t AbsoluteTime;

enum DrmaaCapability {
    ADVANCE_RESERVATION,
    RESERVE_SLOTS,
    CALLBACK,
    BULK_JOBS_MAXPARALLEL,
    JT_EMAIL,
    JT_STAGING,
    JT_DEADLINE,
    JT_MAXSLOTS,
    JT_ACCOUNTINGID,
    RT_STARTNOW,
    RT_DURATION,
    RT_MACHINEOS,
    T_MACHINEARCH
};

enum JobState {
    UNDETERMINED,
    QUEUED,
    QUEUED_HELD,
    RUNNING,
    SUSPENDED,
    REQUEUED,
    REQUEUED_HELD,
    DONE,
    FAILED
};
enum OperatingSystem {
    AIX = 0,
    BSD = 1,
    LINUX = 2,
    HPUX = 3,
    IRIX = 4,
    MACOS = 5,
    SUNOS = 6,
    TRUE64 = 7,
    UNIXWARE = 8,
    WI = 9,
    WINNT = 10,
    OTHER_OS = 11
};

enum CpuArchitecture {
    ALPHA = 0,
    ARM = 1,
    CELL = 2,
    PARISC = 3,
    X86 = 4,
    X64 = 5,
    IA64 = 6,
    MIPS = 7,
    PPC = 8,
    PPC64 = 9,
    SPARC = 10,
    SPARC64 = 11,
    OTHER_CPU = 12
};
template<class T>
typedef map<string, T> Dictionary;

typedef list<string> StringList;
typedef list<string> OrderedStringList;
enum DrmaaEvent {
    NEW_STATE, MIGRATED, ATTRIBUTE_CHANGE
};

class DrmaaCallback {
    void notify(DrmaaNotification notification) = 0;
};
struct DrmaaNotification {
    DrmaaEvent event;
    string jobId;
    string sessionName;
    JobState jobState;
};
struct Version {
    string major;
    string minor;
};
struct ReservationTemplate {
    string reservationName;
    time_t startTime;
    time_t endTime;
    time_t duration;
    long minSlots;
    long maxSlots;
    set<string> usersACL;
    vector<string> candidateMachines;
    long minPhysMemory;
    OperatingSystem machineOS;
    CpuArchitecture machineArch;
};
struct QueueInfo {
    string name;
};
typedef list<QueueInfo> QueueInfoList;

struct JobInfo {
    string jobId;
    long exitStatus;
    string terminatingSignal;
    string annotation;
    JobState jobState;
    string jobSubState;
    vector<string> allocatedMachines;
    string submissionMachine;
    string jobOwner;
    long slots;
    string queueName;
    time_t wallclockTime;
    long cpuTime;
    time_t submissionTime;
    time_t dispatchTime;
    time_t finishTime;
};
typedef list<JobInfo> JobInfoList;

struct SlotInfo {
    string machineName;
    string slots;
};
typedef list<SlotInfo> SlotInfoList;

struct ReservationInfo {
    string reservationId;
    string reservationName;
    time_t reservedStartTime;
    time_t reservedEndTime;
    set<string> usersACL;
    long reservedSlots;
    SlotInfoList reservedMachines;
};
typedef list<ReservationInfo> ReservationInfoList;

struct JobTemplate {
    string remoteCommand;
    vector<string> args;
    bool submitAsHold;
    bool rerunnable;
    Dictionary<string> jobEnvironment;
    string workingDirectory;
    string jobCategory;
    set<string> email;
    bool emailOnStarted;
    bool emailOnTerminated;
    string jobName;
    string inputPath;
    string outputPath;
    string errorPath;
    bool joinFiles;
    string reservationId;
    string queueName;
    long minSlots;
    long maxSlots;
    long priority;
    vector<string> candidateMachines;
    long minPhysMemory;
    OperatingSystem machineOS;
    CpuArchitecture machineArch;
    time_t startTime;
    time_t deadlineTime;
    Dictionary<string> stageInFiles;
    Dictionary<string> stageOutFiles;
    Dictionary<string> resourceLimits;
    string accountingId;
};

struct MachineInfo {
    string name;
    bool available;
    long sockets;
    long coresPerSocket;
    long threadsPerCore;
    double load;
    long physMemory;
    long virtMemory;
    OperatingSystem machineOS;
    Version machineOSVersion;
    CpuArchitecture machineArch;
};
typedef list<MachineInfo> MachineInfoList;

class Drmaa2Exception;
class DeniedByDrmsException;
class DrmCommunicationException;
class TryLaterException;
class TimeoutException;
class InternalException;
class InvalidArgumentException;
class InvalidSessionException;
class InvalidStateException;
class OutOfResourceException;
class UnsupportedAttributeException;
class UnsupportedOperationException;
class ImplementationSpecificException;

class DrmaaReflective {
    /**
     * TODO : How to support reflective in C++?
     * Java provides reflection
     */
    StringList jobTemplateImplSpec;
    StringList jobInfoImplSpec;
    StringList reservationTemplateImplSpec;
    StringList reservationInfoImplSpec;
    StringList queueInfoImplSpec;
    StringList machineInfoImplSpec;
    StringList notificationImplSpec;
    string getInstanceValue(void *instance, string name);
    void setInstanceValue(void *instance, string name, string value);
    string describeAttribute(void *instance, string name);
};

class JobArray {
public:
    virtual ~JobArray(void);
    virtual string& getJobArrayId(void) const = 0;
    virtual JobList& getJobs(void) const = 0;
    virtual JobSession& getSession(void) const = 0;
    virtual JobTemplate& getJobTemplate(void) const = 0;

    virtual void suspend(void) = 0;
    virtual void resume(void) = 0;
    virtual void hold(void) = 0;
    virtual void release(void) = 0;
    virtual void terminate(void) = 0;
};

class Job {
public:
    virtual ~Job(void);
    virtual const string& getJobId(void) const = 0;
    virtual const JobInfo& getJobInfo(void) const = 0;
    virtual const JobState& getState(string& subState) const = 0;
    virtual const JobTemplate& getJobTemplate(void) const = 0;
    virtual void suspend(void) = 0;
    virtual void resume(void) = 0;
    virtual void hold(void) = 0;
    virtual void release(void) = 0;
    virtual void terminate(void) = 0;
    virtual void waitStarted(TimeAmount& timeout_) = 0;
    virtual void waitTerminated(TimeAmount& timeout_) = 0;
};
typedef list<Job> JobList;

class Reservation {
public:
    virtual ~Reservation(void);
    virtual const string& getReservationId(void) const = 0;
    virtual const ReservationSession& getSession(void) const = 0;
    virtual const ReservationTemplate& getReservationTemplate(void) const = 0;
    virtual const ReservationInfo& getInfo(void) const = 0;
    virtual void terminate(void) = 0;
};
typedef list<Reservation> ReservationList;

class ReservationSession {
public:
    virtual ~ReservationSession(void);
    virtual const string& getContact(void) const = 0;
    virtual const string& getSessionName(void) const = 0;
    virtual const Reservation& getReservation(string& reservationId_) = 0;
    virtual const Reservation& requestReservation(
            const ReservationTemplate& reservationTemplate_) = 0;
    virtual const ReservationList& getReservations(void) = 0;
};

class JobSession {
public:
    virtual ~JobSession(void);
    virtual const string& getContact(void) const = 0;
    virtual const string& getSessionName(void) const = 0;
    virtual const StringList getJobCategories(void) const = 0;
    virtual const JobList& getJobs(const JobInfo& filter_) = 0;
    virtual const JobArray& getJobArray(const string& jobArrayId_) = 0;
    virtual const string& runJob(const JobTemplate& jobTemplate_) = 0;
    virtual const JobArray& runBulkJobs(const JobTemplate& jobTemplate_,
            const long beginIndex_, const long endIndex_, const long step_,
            const long maxParallel_) = 0;
    virtual const Job& waitAnyStarted(const JobList& jobs_const,
            const TimeAmount timeout_) = 0;
    virtual const Job& waitAnyTerminated(const JobList& jobs_,
            const TimeAmount timeout_) = 0;
};

class MonitoringSession {
public:
    virtual ~MonitoringSession(void);
    virtual const MachineInfoList& getAllMachines(list<string> machines_) = 0;
    virtual const ReservationList& getAllReservations(void) = 0;
    virtual const JobList& getAllJobs(JobInfo& filter_) = 0;
    virtual const QueueInfoList& getAllQueues(list<string> queues_) = 0;
};

class SessionManager {

private:
    SessionManager();

public:
    /**
     * SessionManager as singleton
     */
    static SessionManager& getInstance() = 0;

public:
    virtual ~SessionManager(void);
    virtual const string& getDrmsName(void) const = 0;
    virtual const Version& getDrmsVersion(void) const = 0;
    virtual const Version& getDrmaaVersion(void) const = 0;

    virtual bool supports(const DrmaaCapability& capability_) = 0;

    virtual const JobSession& createJobSession(const string& sessionName_,
           drmaa2_error -const returnsstring& DRMAA2contact_SUCCESS) if= successful DRMAA2_INVALID_SESSION if session is invalid

   drmaa2_error drmaa2_close_msession (drmaa2_msession ms_)0;
    virtual const JobSession& openJobSession(const string& sessionName_) = 0;
    virtual void closeJobSession(JobSession&  Dis-associates monitoring session from DRMS. Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

       Parameters:session_) = 0;
    virtual void destroyJobSession(const string& sessionName_) = 0;

    virtual const ReservationSession& createReservationSession(
            const string& mssessionName_, -const pointer to drmaa2 monitoring session created earlier.

       Side-Effects: nonestring& contact_) = 0;
    virtual const ReservationSession& openReservationSession(
            Returns:const string& sessionName_) = 0;
    virtual void closeReservationSession(ReservationSession& DRMAA2session_SUCCESS) if= succeeds0;
NULL and also sets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if failsvoid destroyReservationSession(const string& sessionName_) = 0;

    virtual drmaa2_error drmaa2_close_rsession (drmaa2_rsession rs_)const MonitoringSession& openMonitoringSession(
        Disassociates reservation session from DRMS.const Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

 string& contact_) = 0;
    virtual void closeMonitoringSession(MonitoringSession& session_) = 0;

    Parameters:virtual const StringList& getReservationSessionNames(void) = 0;
    virtual const rs_ - pointer to drmaa2 reservation session created earlier.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if succeeds NULL and also sets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if fails

   drmaa2_jsession drmaa2_create_jsession (const char * session_name_, const char * contact_)
       Creates a drmaa2 job session for a given name and contact.

       Parameters:
           session_name_ - Name of the session .StringList& getJobSessionNames(void) = 0;

};

typedef const char * drmaa2_string;
typedef struct drmaa2_list_s * drmaa2_list;
typedef struct drmaa2_list_s * drmaa2_string_list;
typedef struct drmaa2_list_s * drmaa2_j_list;
typedef struct drmaa2_list_s * drmaa2_queueinfo_list;
typedef struct drmaa2_list_s * drmaa2_machineinfo_list;
typedef struct drmaa2_list_s * drmaa2_slotinfo_list;
typedef struct drmaa2_list_s * drmaa2_r_list;
typedef struct drmaa2_dict_s * drmaa2_dict;
typedef drmaa2_jinfo_s * drmaa2_jinfo;
typedef drmaa2_slotinfo_s * drmaa2_slotinfo;
typedef drmaa2_rinfo_s * drmaa2_rinfo;
typedef drmaa2_jtemplate_s * drmaa2_jtemplate;
typedef drmaa2_rtemplate_s * drmaa2_rtemplate;
typedef drmaa2_notification_s * drmaa2_notification;
typedef drmaa2_queueinfo_s * drmaa2_queueinfo;
typedef drmaa2_version_s * drmaa2_version;
typedef drmaa2_machineinfo_s * drmaa2_machineinfo;
typedef struct drmaa2_jsession_s * drmaa2_jsession;
typedef struct drmaa2_rsession_s * drmaa2_rsession;
typedef struct drmaa2_msession_s * drmaa2_msession;
typedef struct drmaa2_j_s        * drmaa2_j;
typedef struct  contactdrmaa2_jarray_s - DRMS name.

  * drmaa2_jarray;
typedef struct drmaa2_r_s     Side-Effects: none  * drmaa2_r;


/**
  Note Returns: Names ending with _s are forward declaration 
**/ 

typedef enum drmaa2_jsessionjstate {
if succeeds NULL if failsDRMAA2_UNDETERMINED and sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error.     drmaa2_rsession drmaa2_create_rsession (const char * session_name_,= const char0,
* contact_)   DRMAA2_QUEUED     Creates a drmaa2 reservation session for a given name and contact.       =  Parameters:1,
    DRMAA2_QUEUED_HELD       session_name_ - Name of the session.     =  2,
    contactDRMAA2_RUNNING - DRMS name.         Side-Effects: none        = Returns: 3,
    DRMAA2_SUSPENDED      drmaa2_jsession if succeeds NULL if fails and sets DRMAA2_INVALID_ARGUMENT error.    = drmaa2_string drmaa2_describe_attribute (const void * instance, const char * name) 4,
    DRMAA2_REQUEUED       drmaa2_error drmaa2_destroy_jsession (const char * session_name_)        drmaa2_destroy_jsession= - destroys5,
the drmaa2_job session pointed byDRMAA2_REQUEUED_HELD js         Parameters:     =  6,
    sessionDRMAA2_name_DONE - pointer to drmaa2_job session which needs to be closed         Side-Effects: none    =  7,
    DRMAA2_FAILED  @return                DRMAA2_SUCCESS if successful  =  8
} drmaa2_jstate;

/**
Note : Refer DRMAA2_INVALID_ARGUMENT if session name is invalid

DRMAA State Model in specfication
**/

   drmaa2_error drmaa2_destroyclose_rsessionjsession (const char * session_name_)drmaa2_jsession js_)
       drmaa2_close_jsession - Reapscloses the persisteddrmaa2_job orsession cachedpointed stateby informationjs
for
the given session name.    Parameters:
    Parameters:       js_ - pointer to drmaa2_job session_name_ -which Nameneeds ofto thebe session.closed

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful DRMAA2_INVALID_ARGUMENTSESSION if session name is invalid

   drmaa2_dicterror drmaa2_dictclose_createmsession (const drmaa2_dict_entryfree callback)
       This function creates a drmaa dictionarymsession ms_)
       Dis-associates monitoring session from DRMS. Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

       Parameters:
           ms_  callback - Call back function to call when free is called.

       Side-Effects: none

       Returns:
           drmaa2_dict

   drmaa2_error drmaa2_dict_del (drmaa2_dict d, const char * key)
       This function deletes the entry with specified key from the dictionary.

       Parameters:
           d - Pointer to drmaa dict- pointer to drmaa2 monitoring session created earlier.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if succeeds NULL and also sets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if fails

   drmaa2_error drmaa2_close_rsession (drmaa2_rsession rs_)
       Disassociates reservation session from DRMS. Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

       Parameters:
           rs_ - pointer to drmaa2 reservation session created earlier.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS keyif -succeeds pointerNULL toand keyalso stringsets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if fails

Side-Effects: none  drmaa2_jsession drmaa2_create_jsession (const char    Returns:
   * session_name_, const char * contact_)
       drmaa2_errorCreates -a DRMAA2_SUCCESSdrmaa2 job session for a given name and  contact.

  · DRMAA2_INVALID_ARGUMENT    Parameters:
void drmaa2_dict_free (drmaa2_dict * dRef)       session_name_ This- functionName freesof athe drmaasession dict.
        Parameters:   contact_ - DRMS name.

    dRef - Pointer to drmaa dictSide-Effects: none

        Side-EffectsReturns:
none         Returns:  drmaa2_jsession if succeeds NULL if fails and sets drmaa2_lasterror_v to void
DRMAA2_INVALID_ARGUMENT error.

  const char*drmaa2_rsession drmaa2_dictcreate_getrsession (const drmaa2_dict d char * session_name_, const char * keycontact_)
       This function gets the key's value from the dictionaryCreates a drmaa2 reservation session for a given name and contact.

       Parameters:
           dsession_name_ - PointerName toof drmaathe dictsession.
           keycontact_ - pointer to key stringDRMS name.

        Side-Effects: none

       Returns:
           drmaa2_jsession if succeeds NULL if fails and sets char *DRMAA2_INVALID_ARGUMENT error.

   drmaa2_boolstring drmaa2_dictdescribe_hasattribute (const drmaa2_dict dvoid * instance, const char * keyname)
   drmaa2_error drmaa2_destroy_jsession (const char * session_name_)
 This function checks for the presence of key in the dictionary.drmaa2_destroy_jsession - destroys the drmaa2_job session pointed by js

       Parameters:
           dsession_name_ - Pointerpointer to drmaa2_job drmaasession dictwhich needs to be closed

      key Side- pointer to key stringEffects: none

           @return
            Side-Effects: none  DRMAA2_SUCCESS if successful
    Returns:       DRMAA2_INVALID_ARGUMENT if session name is drmaa2_boolinvalid

   drmaa2_string_listerror drmaa2_dictdestroy_listrsession (const drmaa2_dict d) char * session_name_)
       Reaps Thisthe functionpersisted returnsor acached drmaastate listinformation offor keysthe ingiven thesession dictionaryname.

       Parameters:
           dsession_name_ - PointerName toof drmaathe dictsession.

       Side-Effects: none

       Returns:
           drmaa2DRMAA2_string_listSUCCESS if successful   drmaa2_error drmaa2_dict_set (drmaa2_dict d, const char * key, const char * val)
       This function sets the key value pair to the dictionary.

  DRMAA2_INVALID_ARGUMENT if session name is invalid

   Parameters:
   drmaa2_dict drmaa2_dict_create (const drmaa2_dict_entryfree callback)
       dThis -function Pointercreates toa drmaa dictdictionary.

          key - pointer to key stringParameters:
           callback - Call back function valto -call pointerwhen tofree valueis stringcalled.

       Side-Effects: none

       Returns:
           drmaa2_error - DRMAA2_SUCCESS

  dict

       · DRMAA2_INVALID_ARGUMENT

   drmaa2_stringerror drmaa2_getdict_drmaa_namedel (void)
    drmaa2_dict d, const char * key)
  drmaa2_get_drmaa_name - returns the DRM applicationThis namefunction deletes the entry with specified key from the Parameters:dictionary.

       Parameters:
  - void        d Side-Effects: none
- Pointer to drmaa dict
           ·key - pointer to key string

  Returns:     Side-Effects: none

    drmaa2_string   Returns:
 drmaa2_version drmaa2_get_drmaa_version (void)        drmaa2_get_drmaa_versionerror - returnsDRMAA2_SUCCESS
the
DRM application version         Parameters:
· DRMAA2_INVALID_ARGUMENT

   void drmaa2_dict_free (drmaa2_dict * dRef)
 - void     This function frees a Side-Effects: nonedrmaa dict.

       ReturnsParameters:
           drmaa2_versiondRef - Pointer to  drmaa2_string drmaa2_get_drms_name (void)drmaa dict

      drmaa2_get_drms_name Side-Effects: returns thenone
DRM
system name         ParametersReturns:

          - void

   const char* drmaa2_dict_get  Side-Effects: none

  (const drmaa2_dict d, const char * key)
    Returns:   This function gets the key's value from the dictionary.
drmaa2_string
    drmaa2_version drmaa2_get_drms_version (void) Parameters:
      drmaa2_get_drms_version - returns the DRM systemd version- Pointer to drmaa dict
    Parameters:       key - pointer to key -string
void
        Side-Effects: none

       Returns:
           char drmaa2_version*

   drmaa2_stringbool drmaa2_getdict_instance_valuehas (const void * instancedrmaa2_dict d, const char * namekey)
   drmaa2_string_list drmaa2_get_jsession_names (void)   This function    drmaa2_get_jsession_names - returnschecks for the listpresence of drmaa2_jobkey sessionsin the dictionary.

     Side-Effects: none         Returns:
           drmaa2_string_list - returns list of job session names available NULL and last error is set

   drmaa2_string_list drmaa2_get_rsession_names (void)Parameters:
           d - Pointer to drmaa dict
         Get a listkey of- allpointer reservationto sessionkey names.string

       Side-Effects: none

       Returns:
           drmaa2_string_listbool
-
list of reservation sessions NULL - If there are no existing reservation sessions

           · If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATIONdrmaa2_string_list drmaa2_dict_list (const drmaa2_dict d)
       This function returns a drmaa list of keys in the dictionary.

       Parameters:
     void drmaa2_j_free (drmaa2_j * j)  d - Pointer to drmaa dict
drmaa2_j_free
- frees the drmaa2_job structure pointed by jSide-Effects: none

      Parameters:    Returns:
       j - pointer to drmaa2_jobstring_list

   drmaa2_error drmaa2_dict_set (drmaa2_dict  Side-Effects: none

    d, const char * key, const char * val)
  Returns:     This function sets the key value pair voidto the dictionary.

 drmaa2_string drmaa2_j_get_id (const drmaa2_j j)  Parameters:
           d - Pointer to drmaa  drmaa2_j_get_id() - Returns newly allocated drmaa2_job id stringdict
           key - pointer to key Parameters:string
           jval - pointer to drmaa2_job structure.value string

       Side-Effects: none

       Returns:
           drmaa2_stringerror - Gets the job id from drmaa2_job NULL - if fails andDRMAA2_SUCCESS

           · DRMAA2_INVALID_ARGUMENT
error
is set     drmaa2_jinfostring drmaa2_j_get_info (const drmaa2_j j)
   drmaa_name (void)
       drmaa2_jget_getdrmaa_info()name - Gets drmaa2_job info structure fromreturns the drmaa2_jobDRM inapplication drmaa2_jname
structure.
        Parameters:
           j - pointer to drmaa2_job structure.void

       Side-Effects: none

       Returns:    ·

      drmaa2_jinfo -Returns:
returns drmaa2_jinfo if successful NULL - if fails and DRMAA2_INVALID_ARGUMENT error isdrmaa2_string
set
    drmaa2_jtemplateversion drmaa2_jget_getdrmaa_jtversion (const drmaa2_j j)
 void)
         drmaa2_jget_getdrmaa_jt()version - Returnsreturns pointerthe ofDRM drmaa2_job template structure from Job.application version

       Parameters:

          j - pointervoid
to
drmaa2_job structure.         Side-Effects: none

       Returns:
    none

      drmaa2_string -Returns:
gets the session name from drmaa2_session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is setdrmaa2_version

   drmaa2_string drmaa2_j_get_sessiondrms_name (const drmaa2_j j)
 void)
         drmaa2_j_get_sessiondrms_name() - Returnsreturns newlythe allocatedDRM sessionsystem name
string
        Parameters:

          j - pointer to drmaa2_job structure.void

       Side-Effects: none

       Returns:
           drmaa2_string
-
gets the session name from drmaa2_version drmaa2_session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set_get_drms_version (void)
       drmaa2_get_drms_version - returns the DRM system version

       Parameters:
       drmaa2_jstate drmaa2_j_get_state (const drmaa2_j j, drmaa2_string * substate)- void

       Side-Effects: none

  drmaa2_j_get_state() - Gets drmaa2_job state fromReturns:
the drmaa2_job in drmaa2_j structure.       drmaa2_version

Parameters:   drmaa2_string drmaa2_get_instance_value (const void * instance, const char * jname)
- pointer to drmaa2_job structure.
string_list drmaa2_get_jsession_names (void)
       drmaa2_get_jsession_names - returns substatethe -list state of the drmaa2_job in drmaa2_jsessions
structure
        Side-Effects: none

       Returns:
           drmaa2_string_jstatelist - returns currentlist of drmaa2_job statesession names available NULL and last drmaa2_errorerror is set

   drmaa2_jstring_holdlist (drmaa2_get_rsession_jnames j(void)
       Get a list of all reservation session names.

 drmaa2_j_hold() - Holds the drmaa2_job in drmaa2_j structure. Side-Effects: none

       ParametersReturns:
           jdrmaa2_string_list - pointerlist toof drmaa2_job structure.

       Side-Effects: nonereservation sessions NULL - If there are no existing reservation sessions

        Returns:   · If this feature is not supported,  set drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for hold

   drmaa2_errorlasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_j_releasefree (drmaa2_j * j)

          drmaa2_j_release()free - Releasesfrees the drmaa2_job structure inpointed by drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job
structure.
        Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for releasevoid

   drmaa2_errorstring drmaa2_j_get_resumeid (const drmaa2_j j)
                   drmaa2_j_resumeget_id() - ResumesReturns newly theallocated drmaa2_job in drmaa2_j structure.id string

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_errorstring - Returns DRMAA2_SUCCESS on success Gets the job id from drmaa2_job NULL - if fails and DRMAA2_INVALID_STATE if job stateARGUMENT error is invalid for resumeset

   drmaa2_errorjinfo drmaa2_j_get_suspendinfo (const drmaa2_j j)
           drmaa2_j_get_suspendinfo() - Suspends Gets drmaa2_job info structure from the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_errorjinfo - Returnsreturns DRMAA2_SUCCESS on successdrmaa2_jinfo if successful NULL - if fails and DRMAA2_INVALID_STATE if job stateARGUMENT error is invalidset
for
suspend     drmaa2_errorjtemplate drmaa2_j_terminateget_jt (const drmaa2_j j)
           drmaa2_j_get_terminatejt() - Returns Terminatespointer theof drmaa2_job template instructure drmaa2_jfrom structureJob.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_errorstring - Returns DRMAA2_SUCCESS on success gets the session name from drmaa2_session NULL - if fails and DRMAA2_INVALID_STATEARGUMENT if joberror state is invalid for terminateset

   drmaa2_errorstring drmaa2_j_waitget_session_startedname (const drmaa2_j j, const time_t timeout)
           drmaa2_j_waitget_session_startedname() - BlocksReturns tillnewly theallocated drmaa2_jobsession is started or till timeout expiresname string

       Parameters:
           j - pointer to drmaa2_job structure.
     

    timeout - Timeout in time_t format.

       Side-Effects: none

       Returns:
           drmaa2_errorstring - returns DRMAA2_SUCCESS gets the session name from drmaa2_session NULL - if successfulfails and DRMAA2_TIMEOUTINVALID_ARGUMENT iferror timeoutis happenedset

   drmaa2_errorjstate drmaa2_j_waitget_terminatedstate (const drmaa2_j j, const time_t timeoutdrmaa2_string * substate)
           drmaa2_j_waitget_terminatedstate() - Blocks till Gets drmaa2_job state from the drmaa2_job isin terminated or till timeout expiresdrmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.
           timeoutsubstate - Timeout state of the drmaa2_job in timedrmaa2_tj format.structure

       Side-Effects: none

       Returns:
           drmaa2_errorjstate - returns DRMAA2_SUCCESS if successful DRMAA2_TIMEOUT if timeout happenedcurrent drmaa2_job state

   drmaa2_error  void drmaa2_jarrayj_freehold (drmaa2_jarray * ja)j j)
           drmaa2_jarrayj_freehold() - freesHolds the drmaa2_job arrayin drmaa2_j structure pointed.
by
ja         Parameters:
           jaj - pointer to DRMAA jo array drmaa2_job structure.

       Side-Effects: none

       Returns:
   Side-Effects: none       drmaa2_error - Returns: DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for hold
void
    drmaa2_stringerror drmaa2_jarrayj_get_idrelease (const drmaa2_jarrayj jaj)
           drmaa2_jarrayj_get_idrelease() - GetsReleases the id from drmaa2drmaa2_job in drmaa2_jobj arraystructure.

       Parameters:
           jaj - pointer to drmaa2_job arraystructure.

       Side-Effects: none

       Returns:
           drmaa2_stringerror - job id of drmaa2_job array NULL -Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if failsjob and DRMAA2_INVALID_ARGUMENT error is setstate is invalid for release

   drmaa2_jtemplateerror drmaa2_jarray_get_job_templatej_resume (const drmaa2_jarrayj jaj)
           drmaa2_jarray_get_job_templatej_resume() - returnsResumes the drmaa2_job template used to submit the in drmaa2_jobj arraystructure.

       Parameters:
           jaj - pointer to drmaa2_job arraystructure.

       Side-Effects: none

       Returns:
           drmaa2_jtemplateerror - returnsReturns jobDRMAA2_SUCCESS templateon fromsuccess drmaa2_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is setDRMAA2_INVALID_STATE if job state is invalid for resume

   drmaa2_j_listerror drmaa2_jarrayj_get_jobssuspend (const drmaa2_jarrayj jaj)
           drmaa2_jarrayj_get_jobssuspend() - ReturnsSuspends the list of jobs drmaa2_job in the drmaa2_jobj array structure.

       Parameters:
           jaj - Pointerpointer to drmaa2_job array structure.

       Side-Effects: none

       Returns:
           drmaa2_j_listerror - Returns getsDRMAA2_SUCCESS liston ofsuccess drmaa2_jobs from drmaa2_jarray NULL - if fails and DRMAA2_INVALID_ARGUMENT error is setDRMAA2_INVALID_STATE if job state is invalid for suspend

   drmaa2_stringerror drmaa2_jarray_get_session_namej_terminate (const drmaa2_jarrayj jaj)
           drmaa2_jarray_get_session_namej_terminate() - getsTerminates the sessiondrmaa2_job name in which the drmaa2_job array is submittedj structure.

       Parameters:
           jaj - pointer to drmaa2_job arraystructure.

       Side-Effects: none

       Returns:
           drmaa2_stringerror - returnsReturns sessionDRMAA2_SUCCESS nameon fromsuccess drmaa2_job array NULL -DRMAA2_INVALID_STATE if failsjob and DRMAA2_INVALID_ARGUMENT error is setstate is invalid for terminate

   drmaa2_error drmaa2_jarrayj_wait_holdstarted (const drmaa2_jarray ja)_j j, const time_t timeout)
           drmaa2_jarray_holdj_wait_started() - Blocks holdstill the drmaa2_job array is started or till timeout expires

       Parameters:
           jaj - pointer to drmaa2_job array structure.
           timeout - Timeout in time_t format.

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful drmaa2DRMAA2_errorTIMEOUT if timeout failshappened

   drmaa2_error drmaa2_j_jarraywait_releaseterminated (const drmaa2_jarray ja)_j j, const time_t timeout)
           drmaa2_j_jarraywait_releaseterminated() - releasesBlocks till the drmaa2_job array is terminated or till timeout expires

       Parameters:
           jaj - pointer to drmaa2_job array structure.
           timeout - Timeout in time_t format.

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful drmaa2DRMAA2_errorTIMEOUT if timeout failshappened

   drmaa2_errorvoid drmaa2_jarray_resumefree (drmaa2_jarray * ja)
       drmaa2_jarray_resumefree - resumesfrees the drmaa2_job array structure pointed by ja

       Parameters:
           ja - pointer to DRMAA drmaa2_jobjo array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESSvoid
if
successful drmaa2_error if fails 
   drmaa2_errorstring drmaa2_jarray_suspendget_id (const drmaa2_jarray ja)
       drmaa2_jarray_suspend - suspends the_get_id() Gets the id from drmaa2 drmaa2_job array.

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successfuldrmaa2_string - job id of drmaa2_errorjob array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_errorjtemplate drmaa2_jarray_get_job_terminatetemplate (const drmaa2_jarray ja)
       drmaa2_jarray_get_job_terminatetemplate - terminates returns the drmaa2_job template used to submit the drmaa2_job array.

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           drmaa2_jtemplate - returns job template from drmaa2_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   Side-Effects: none

 drmaa2_j_list drmaa2_jarray_get_jobs (const drmaa2_jarray ja)
     Returns:  drmaa2_jarray_get_jobs() Returns the list of jobs in the drmaa2_job array DRMAA2_SUCCESSstructure.
if
successful drmaa2_error if fails    Parameters:
drmaa2_jinfo drmaa2_jinfo_create (void)         drmaa2_jinfo_create()ja - createsPointer ato drmaa2_job infoarray structure and returns its
pointer
        Side-Effects: none

       Returns:
           drmaa2_j_jinfolist - pointergets list toof newlydrmaa2_jobs allocatedfrom drmaa2_jinfojarray structure NULL - if allocation fails and DRMAA2_OUTINVALID_OF_RESOURCEARGUMENT error is set

   voiddrmaa2_string drmaa2_jarray_jinfoget_session_freename (const drmaa2_jinfojarray * jiRefja)
        drmaa2_jarray_get_jinfo_free() - freessession_name - gets the session name in which the drmaa2_job infoarray structure and its inner data typesis submitted

       Parameters:
           jiRefja - pointer to drmaa2_job infoarray
structure.
        Side-Effects: none

       Returns:
           drmaa2_string void- returns session name from drmaa2_string_list_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jinfoerror drmaa2_impljarray_spechold (voiddrmaa2_jarray ja)
       drmaa2_jinfojarray_impl_spechold - Listsholds the drmaa spec implementations supported for job info (e.g. drmaa, drmaa2) drmaa2_job array

       Parameters:
           ja Side-Effects: nonepointer to drmaa2_job array

    Returns:   Side-Effects: none

      drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   voiddrmaa2_error drmaa2_jsessionjarray_freerelease (drmaa2_jsessionjarray * jsja)
       drmaa2_jsessionjarray_freerelease - Freesreleases the memory of Job session pointed by jsdrmaa2_job array

       Parameters:
           jsja - pointer to drmaa2_jsession.job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if voidfails

   drmaa2_stringerror drmaa2_jsessionjarray_get_contactresume (const drmaa2_jsessionjarray jsja)
       drmaa2_jsessionjarray_get_contactresume - Returns the DRMS name of resumes the drmaa2_job sessionarray

       Parameters:
           jsja - pointer to drmaa2_job session.array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_jarrayerror drmaa2_jsession_get_job_arrayjarray_suspend (const drmaa2_jsession js, const drmaa2_string jobarrayIdjarray ja)
       drmaa2_jsession_get_job_array - returns the specified job array from drmaa2_jarray_suspend - suspends the drmaa2_job sessionarray

       Parameters:
           jsja - pointer to drmaa2_job session.array

       Side-Effects: none

jobarrayId - Job array id which needs toReturns:
be retrieved         Side-Effects: none

    DRMAA2_SUCCESS if successful drmaa2_error if fails

  Returns: drmaa2_error drmaa2_jarray_terminate (drmaa2_jarray ja)
       drmaa2_jarray_terminate - returnsterminates pointerthe to drmaa2_jarray with specified jobarrayId in the job session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string_list drmaa2_jsession_get_job_categories (const drmaa2_jsession js)job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       drmaa2_jsession_get_job_categories - returns the string list of drmaa2_job categories in the drmaa2_job session

  Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   Parameters:
 drmaa2_jinfo drmaa2_jinfo_create (void)
         js drmaa2_jinfo_create() - pointercreates toa drmaa2_job session info structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_string_listjinfo - returnspointer listto of job categories fromnewly allocated drmaa2_jsessionjinfo structure NULL - if allocation fails and DRMAA2_INVALIDOUT_OF_ARGUMENTRESOURCE error is set

   void drmaa2_jjinfo_listfree (drmaa2_jsession_get_jobs (const drmaa2_jsession js, const drmaa2_jinfo filter)jinfo * jiRef)
        drmaa2_jinfo_free() - frees the drmaa2_job info structure and its inner data types

       Parameters:
           jiRef - pointer to drmaa2_jsession_get_jobs - returns list of jobs in the drmaa2_job session matching the jobinfo filterjob info structure.

       Side-Effects: none

       Returns:
 Parameters:          void

js - pointer todrmaa2_string_list drmaa2_jinfo_impl_jobspec session(void)
js       drmaa2_jinfo_impl_spec - Lists the drmaa filterspec -implementations filtersupported for gettingjob jobs with specific conditionsinfo (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_jstring_list - returns list of drmaa jobsspec implementations matchingsupported theNULL drmaa2_job- filterIf providedthis NULLfeature -is ifnot failssupported, andset DRMAA2drmaa2_INVALIDlasterror_ARGUMENTv error is setto DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_string drmaa2_jsession_get_session_namefree (const drmaa2_jsession * js)
       drmaa2_jsession_get_session_name - returns thefree Frees the memory of Job session namepointed from drmaa2_job session.by js

       Parameters:
           js - pointer to drmaa2_job sessionjsession.

       Side-Effects: none

       Returns:
           drmaa2_stringvoid
-
returns session name from drmaa2_jsession NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

  string drmaa2_jarray drmaa2_jsession_runget_bulk_jobscontact (const drmaa2_jsession js_,)
const drmaa2_jtemplate jt_, unsigned long begin_index_, unsigned long enddrmaa2_index_, unsigned long step_, unsigned long
       max_parallel_)jsession_get_contact - Returns the DRMS name of the drmaa2_job session

       WriteParameters:
description of function here.        js Parameters:- pointer to drmaa2_job session.

      js_ - pointer to drmaa2_job sessionSide-Effects: none

       Returns:
  jt_ - Job template to be considered or used DRMAA2_SUCCESS if successful drmaa2_error if fails

    begin_index_ - Starting index of drmaa2_job arraydrmaa2_jarray drmaa2_jsession_get_job_array (const drmaa2_jsession js, const drmaa2_string jobarrayId)
           end_index_drmaa2_jsession_get_job_array - Endingreturns indexthe ofspecified drmaa2_job array from the drmaa2_job session

      step_ -Parameters:
Increment between each jobs        js - pointer to maxdrmaa2_parallel_job -session.
Maximum parallel jobs to run        jobarrayId Side-Effects: noneJob array id which needs to be retrieved

Returns:            drmaa2_jarray - returns pointer to drmaa2_jarray if successful NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to DRMAA2_INTERNAL
           if any internal error occursSide-Effects: none

       Returns:
           drmaa2_jarray - returns pointer to drmaa2_jarray with specified jobarrayId in the job session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string_jlist drmaa2_jsession_runget_job_categories (const drmaa2_jsession js_, const drmaa2_jtemplate jt_)
       drmaa2_jsession_runget_job_categories - runsreturns the jobstring inlist theof drmaa2_job sessioncategories within the drmaa2_job template specifiedsession

       Parameters:
           js_ - pointer to drmaa2_job session
           jt_ - Job template that needs to be run

       Side-Effects: none

       Returns:
           drmaa2_j - returns pointer to job which is newly started in the job session NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to
           DRMAA2_INVALID_SESSION if session name is invalid_job session

       Side-Effects: none

       Returns:
           drmaa2_string_list - returns list of job categories from drmaa2_jsession NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_j_list drmaa2_jsession_waitget_any_startedjobs (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeoutjinfo filter)
       drmaa2_jsession_waitget_any_startedjobs - blocksreturns tilllist theof drmaa2_jobjobs in the drmaa2_job session startedmatching or till the timejobinfo outfilter

       Parameters:
           js - pointer to drmaa2_job session js
          l - list of drmaa2_jobs
           timeout - timeout to wait if event has not occurredfilter - filter for getting jobs with specific conditions

       Side-Effects: none

       Returns:
           drmaa2_j_list - returns pointer to list of jobs matching the drmaa2_job whichfilter startedprovided NULL and- lastif error is set tofails and DRMAA2_TIMEOUTINVALID_ARGUMENT iferror timeoutis happensset

   drmaa2_jstring drmaa2_jsession_waitget_anysession_terminatedname (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout)
       drmaa2_jsession_waitget_anysession_terminatedname - blocks tillreturns the drmaa2_jobsession inname thefrom drmaa2_job session ended or till the time out.

       Parameters:
           js - pointer to drmaa2_job session
           l - list of drmaa2_jobs
           timeout - timeout to wait if event has not occursjob session

       Side-Effects: none

       Returns:
           drmaa2_jstring - returns pointersession name tofrom drmaa2_jobjsession NULL which- terminatedif NULLfails and lastDRMAA2_INVALID_ARGUMENT error is set

to DRMAA2_TIMEOUT if timeout happens

  drmaa2_jarray drmaa2_jsession_run_bulk_jobs (const drmaa2_jsession js_, const drmaa2_jtemplate drmaa2_jtemplate_create (void)
 jt_, unsigned long begin_index_, unsigned long end_index_, unsigned long step_, unsigned long
       drmaa2max_jtemplateparallel_create()
-   creates a drmaa2_job template structureWrite anddescription returnsof itsfunction pointerhere.

       Side-Effects: noneParameters:
           js_ - pointer  Returns:to drmaa2_job session
           drmaa2jt_jtemplate - pointerJob template to drmaa2_jtemplate if allocated NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_jtemplate_free (drmaa2_jtemplate * jtemplate)be considered or used
           begin_index_ - Starting index of drmaa2_job array
           drmaa2end_jtemplateindex_free() - Ending freesindex aof drmaa2_job array
template  structure and its inner data types    step_ - Increment between each Parameters:jobs
           jtemplatemax_parallel_ - pointerMaximum toparallel drmaa2_jobjobs templateto structure.run

       Side-Effects: none

       Returns:
           voiddrmaa2_jarray - returns pointer to drmaa2_string_list drmaa2_jtemplate_impl_spec (void)
       drmaa2_jtemplate_impl_spec - Lists the drmaa spec implementations supported for job template (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   drmaa2_error drmaa2_lasterror (void)
       This function returns the last occurred error.jarray if successful NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to DRMAA2_INTERNAL
           if any internal error occurs

   drmaa2_j drmaa2_jsession_run_job (const drmaa2_jsession js_, const drmaa2_jtemplate jt_)
       drmaa2_jsession_run_job - runs job in the job session with the drmaa2_job template specified

       Parameters:
           js_ - pointer to drmaa2_job session
           jt_ - Job template that needs to be run

       Side-Effects: none

       Returns:
           drmaa2_errorj - returns   drmaa2_string drmaa2_lasterror_text (void)
       This function returns the last occurred error in string.

       Side-Effects: nonepointer to job which is newly started in the job session NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to
         Returns:  DRMAA2_INVALID_SESSION if session name is invalid

   drmaa2_string - newly allocated string of last error NULL - If no error text existsj drmaa2_jsession_wait_any_started (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout)
       drmaa2_error_jsession_wait_any_started - blocks till the drmaa2_list_add (drmaa2_list l, const void * value)job in the drmaa2_job session started or till the time out

       Parameters:
This function adds an element to the list.    js - pointer to drmaa2_job Parameters:session
           l - Pointerlist toof drmaadrmaa2_jobs
list            valuetimeout - pointertimeout to thewait elementif whichevent needshas tonot be insertedoccurred

       Side-Effects: none

       Returns:
           drmaa2_errorj - DRMAA2_INVALID_ARGUMENTreturns pointer to drmaa2_job which started NULL and last error is set  ·to DRMAA2_OUT_OF_RESOURCETIMEOUT if timeout happens

        · DRMAA2_SUCCESS

   drmaa2_list drmaa2_list_createdrmaa2_j drmaa2_jsession_wait_any_terminated (const drmaa2_listtypejsession tjs, const drmaa2_j_list_entryfree callback)l, const time_t timeout)
    This function creates a drmaa list.

       Parameters:
           t - Type of the list which needs to be created drmaa2_jsession_wait_any_terminated - blocks till the drmaa2_job in the drmaa2_job session ended or till the time out

       Parameters:
           js - pointer callbackto -drmaa2_job Callsession
back function to call when free is called.    l - list of  Side-Effects: nonedrmaa2_jobs
          Returns: timeout - timeout to wait if event has not occurs

drmaa2_list     drmaa2_error drmaa2_list_del (drmaa2_list l, long pos) Side-Effects: none

       Returns:
This function deletes an element from the list.    drmaa2_j - returns pointer to Parameters:drmaa2_job which terminated NULL and last error is set to DRMAA2_TIMEOUT if ltimeout -happens
Pointer
to drmaa list drmaa2_jtemplate drmaa2_jtemplate_create (void)
        posdrmaa2_jtemplate_create() - positioncreates ofa thedrmaa2_job elementtemplate whichstructure needsand toreturns beits deletedpointer

       Side-Effects: none

       Returns:
           drmaa2_errorjtemplate - DRMAA2_INVALID_ARGUMENTpointer to drmaa2_jtemplate if allocated NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error ·is DRMAA2_SUCCESSset

   void drmaa2_listjtemplate_free (drmaa2_listjtemplate * ljtemplate)
       s This function drmaa2_jtemplate_free() - frees a drmaadrmaa2_job listtemplate structure and its inner data types

 Parameters:      Parameters:
     l - Pointer to drmaa list 
       Side-Effects: none

       Returns:
           void

   const void* drmaa2_list_get (const drmaa2_list l, long index)
       This function gets the element form a particular position of the list.jtemplate - pointer to drmaa2_job template structure.

       Side-Effects: none

       ParametersReturns:
           lvoid
-
Pointer to drmaa drmaa2_string_list drmaa2_jtemplate_impl_spec (void)
       drmaa2_jtemplate_impl_spec - Lists indexthe -drmaa postionspec fromimplementations whcihsupported thefor datajob has to be takentemplate (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           void*drmaa2_string_list - pointerlist toof thedrmaa elementspec retured as void*implementations supported NULL - If thethis positionfeature is not valid

   longsupported, set drmaa2_listlasterror_sizev (const drmaa2_list l)to DRMAA2_UNSUPPORTED_OPERATION

      This function returns the size of the list.

       Parameters:
 drmaa2_error drmaa2_lasterror (void)
       This function lreturns -the Pointerlast to drmaa listoccurred error.

       Side-Effects: none

       Returns:
           long - size of listdrmaa2_error

    drmaa2_machineinfostring drmaa2_machineinfolasterror_createtext (void)
        drmaa2_machineinfo_create() - creates a drmaa2_machineinfo info structure and returns its pointerThis function returns the last occurred error in string.

       Side-Effects: none

       Returns:
           drmaa2_machineinfostring - pointer to newly allocated drmaa2_machineinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_machineinfo_free (drmaa2_machineinfo * miRef)
       This function frees the pre-allocated drmaa machine info structure.

       Parameters:
string of last error NULL - If no error text exists

   drmaa2_error drmaa2_list_add (drmaa2_list l, const void miRef* -value)
Pointer to drmaa machine info   This function adds an element to Side-Effects: nonethe list.

       ReturnsParameters:
           voidl - Pointer to drmaa drmaa2_string_list drmaa2_machineinfo_impl_spec (void)
           drmaa2_machineinfo_impl_specvalue - pointer Liststo the element machinewhich infoneeds specto implementationsbe supportedinserted

       Side-Effects: none

       Returns:
           drmaa2_string_listerror -list ofDRMAA2_INVALID_ARGUMENT
machineinfo
spec implementations supported NULL - If this feature is not supported, set· drmaa2DRMAA2_OUT_lasterror_v to DRMAA2_UNSUPPORTED_OPERATIONOF_RESOURCE

          void drmaa2_msession_free (drmaa2_msession * ms)· DRMAA2_SUCCESS

   drmaa2_j_list drmaa2_msession_get_all_jobslist_create (const drmaa2_msessionlisttype ms_t, const drmaa2_jinfo filter_)list_entryfree callback)
       This function creates Returnsa thedrmaa list.

of    all jobs i.e. DRMAA2 jobs and the jobs submitted out of DRMAA2 library also. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might be
       limited to contain only the jobs seen by the DRMAA2 user. Parameters:
           t - Type of the list which needs to be created
           callback - Call back function to call when free is called.

       Side-Effects: none

       ParametersReturns:
           msdrmaa2_list

  - pointer to drmaa2_msession created earlier
           filter_ - of type drmaa2_jinfo (through which we can query jobs per jobstate, job owner and per queue etc

       Side-Effects: nonedrmaa2_error drmaa2_list_del (drmaa2_list l, long pos)
       This function deletes an element from the list.

       Parameters:
           l - Pointer to drmaa list
           pos - Returns:position of the element which needs to be deleted

  drmaa2_j_list if succeeds NULL if failsSide-Effects: none

  drmaa2_machineinfo_list drmaa2_msession_get_all_machines (const drmaa2_msession ms_, const drmaa2_string_list names_)Returns:
         Returns list ofdrmaa2_error machines or hosts available for submitting jobs in the DRMS system.- DRMAA2_INVALID_ARGUMENT

           · DRMAA2_SUCCESS

  Parameters: void drmaa2_list_free (drmaa2_list * l)
      ms_ pointers toThis drmaa2_msessionfunction createdfrees earliera drmaa list

       Parameters:
names_ a list of queue names acts as filter i.e. we fetchl info- ofPointer onlyto thesedrmaa queues.list

       Side-Effects: none

       Returns:
           drmaa2_machineinfo_listvoid
if
succeeds NULL if fails.const void*    drmaa2_queueinfo_list drmaa2_msession_get_all_queues (const drmaa2_msessionlist ms_l, const drmaa2_string_list names_)long index)
       This Returnsfunction listgets ofthe queueselement availableform fora submittingparticular jobsposition inof the DRMS systemlist.

       Parameters:
           l ms_- pointerPointer to drmaa2_msession created earlier drmaa list
           index - postion from names_whcih athe listdata ofhas queueto namesbe actstaken
as
filter i.e. we fetch info of only these queues.Side-Effects: none

       Side-EffectsReturns:
  none         Returns:void* - pointer to the element retured as void* NULL - If drmaa2_queueinfo_list if succeeds NULL if fails.the position is not valid

   long drmaa2_r_list drmaa2_msession_get_all_reservations_size (const drmaa2_msessionlist ms_)l)
       This function returns the size Returnsof the list of all advance reservations visible for the user running the DRMAA-based application. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might.

       Parameters:
           l - Pointer to drmaa list

       Side-Effects: none

       Returns:
          be limitedlong to- containsize onlyof thelist
reservations
seen by the DRMAA2 user.

drmaa2_machineinfo drmaa2_machineinfo_create (void)
      Parameters:  drmaa2_machineinfo_create() - creates a drmaa2_machineinfo info structure and returns  ms_its pointer to drmaa2_msession created earlier

       Side-Effects: none

       Returns:
           drmaa2_j_list if succeeds NULL if failsmachineinfo - pointer to newly allocated drmaa2_machineinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_notificationmachineinfo_free (drmaa2_notificationmachineinfo * nRefmiRef)
       This function frees the pre-allocated drmaa notificationmachine info structure.

       Parameters:
           nRefmiRef - Pointer to drmaa machine notificationinfo

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_notificationmachineinfo_impl_spec (void)
       drmaa2_notificationmachineinfo_impl_spec - Lists the notificationmachine info spec implementations supported

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of notificationmachineinfo spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   drmaa2_jsessionvoid drmaa2_openmsession_jsessionfree (const chardrmaa2_msession * session_name_ms)
   drmaa2_j_list drmaa2_msession_get_all_jobs (const  drmaa2_openmsession ms_jsession, -const Opens an already existing drmaa2_job sessiondrmaa2_jinfo filter_)
       Returns the list of all  Parameters:
           session_name_ - Session name of the drmaa2_job session which needs to be opened

       Side-Effects: none

       Returns:
   jobs i.e. DRMAA2 jobs and the jobs submitted out of DRMAA2 library also. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might be
       limited to contain only the jobs seen by the DRMAA2 user.

      drmaa2_jsession -Parameters:
returns pointer to drmaa2_jsession for a session which is already present NULLms_ - ifpointer failsto and DRMAA2_INVALID_ARGUMENT error is setdrmaa2_msession created earlier
      drmaa2_msession drmaa2_open_msession (const char * contactfilter_) - of type drmaa2_jinfo (through which we Openscan thequery monitoringjobs session.

       Parameters:
per jobstate, job owner and per queue etc

       Side-Effects: none
contact_
- Contact of the session   Returns:
     Side-Effects: none     drmaa2_j_list if succeeds NULL Returns:if fails

   drmaa2_machineinfo_list drmaa2_msession_get_all_machines (const drmaa2_msession ms_, const drmaa2_msession if the session exists NULL if the session does not exist and if session name is invalid and also sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error_string_list names_)
       Returns list of machines or hosts available for submitting jobs in the DRMS system.

       drmaa2_rsession drmaa2_open_rsession (const char * session_name_)Parameters:
           ms_ Openspointer theto previouslydrmaa2_msession created session.earlier
         Parameters:  names_ a list of queue names acts as filter  session_name_ - Namei.e. we fetch info of theonly these sessionqueues.

       Side-Effects: none

       Returns:
           drmaa2_machineinfo_rsessionlist if a sessionsucceeds exists NULL if sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT errorfails.

   drmaa2_queueinfo_list drmaa2_msession_get_queueinfoall_createqueues (void)const drmaa2_msession       ms_, const drmaa2_queueinfostring_create() - creates a drmaa2_queueinfo structure and returns its pointer

       Side-Effects: nonelist names_)
        Returns: list of queues available for submitting jobs in    drmaa2_queueinfo - pointer to newly allocated drmaa2_queueinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is setthe DRMS system.

       void drmaa2_queueinfo_free (drmaa2_queueinfo * qiRef)Parameters:
           Thisms_ functionpointer freesto the pre-allocated drmaa queueinfo structure.drmaa2_msession created earlier
          Parameters: names_ a list of queue names acts as filter i.e. we qiReffetch -info Pointerof toonly drmaathese queueinfoqueues.

       Side-Effects: none

       Returns:
           voiddrmaa2_queueinfo_list if succeeds NULL if fails.

   drmaa2_stringr_list drmaa2_msession_queueinfoget_implall_specreservations (voidconst drmaa2_msession ms_)
       drmaa2_queueinfo_impl_spec - Lists the queue info spec implementations supported

       Side-Effects: none

       Returns:
  Returns the list of all advance reservations visible for the user running the DRMAA-based application. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might
       be drmaa2_string_list -list of queueinfo spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION
limited to contain only the reservations seen by the DRMAA2 user.

       Parameters:
   void drmaa2_r_free (drmaa2_r * r)    drmaa2ms_string drmaa2_r_get_id (const pointer to drmaa2_rmsession r)created earlier

     Get the reservation id from a given reservation object.Side-Effects: none

           ParametersReturns:
           r - given reservation object
drmaa2_j_list if succeeds NULL if fails

   void drmaa2_notification_free  Side-Effects: none(drmaa2_notification * nRef)
       This Returns:function frees the pre-allocated  drmaa notification structure.

   drmaa2_string    Parameters:
    Return values:      nRef - Pointer to drmaa notification
-
reservation id     drmaa2_rinfo drmaa2_r_get_info (const drmaa2_r r) Side-Effects: none

       Returns:
Get the reservation info from a given reservation object.   void

    Parameters:
drmaa2_string_list drmaa2_notification_impl_spec (void)
       drmaa2_notification_impl_spec - Lists rthe -notification givenspec reservationimplementations objectsupported

       Side-Effects: none

       Returns:
           drmaa2_rinfostring_list - reservation info object list of notification spec implementations supported NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

    drmaa2_rtemplatejsession drmaa2_r_get_reservation_templateopen_jsession (const drmaa2_r rchar * session_name_)
       Get the reservation template from a given reservation object.drmaa2_open_jsession - Opens an already existing drmaa2_job session

       Parameters:
           r - given reservation objectsession_name_ - Session name of the drmaa2_job session which needs to be opened

       Side-Effects: none

       Returns:
           drmaa2_rtemplate- - reservation templatejsession - returns pointer to drmaa2_jsession for a session which is already present NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_stringmsession drmaa2_r_get_session_nameopen_msession (const char * drmaa2contact_r r)
       GetOpens the reservationmonitoring session name from a given reservation object.

       Parameters:
           rcontact_ - givenContact of reservationthe objectsession

       Side-Effects: none

       Returns:
           drmaa2_string - reservationmsession if the session exists NULL if the session does not exist and if session name is invalid NULLand -also if fails andsets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error is
set
    drmaa2_errorrsession drmaa2_ropen_terminatersession (drmaa2_r r)const char * session_name_)
       Opens Terminatethe apreviously givencreated reservationsession.

       Parameters:
           rsession_name_ - givenName of reservationthe objectsession.

       Side-Effects: none

       Returns:
           drmaa2_error - on success DRMAA2_SUCCESSrsession if a session exists NULL if sets drmaa2_lasterror_v to DRMAA2_DENIEDINVALID_BY_DRMS if failedARGUMENT error.

   drmaa2_errorqueueinfo drmaa2_registerqueueinfo_event_notificationcreate (const drmaa2_callback callbackvoid)
       Registers a drmaa2_queueinfo_callbackcreate() with- thecreates DRMS library. For the first phase of implementation we do not support this.

       Parameters:
a drmaa2_queueinfo structure and returns its pointer

       Side-Effects: none

       Returns:
 callback - a structure of type drmaa2_callback containing the details ofdrmaa2_queueinfo callback- function,pointer eventto etcnewly allocated drmaa2_queueinfo structure NULL - if allocation fails Side-Effects: none

 and DRMAA2_OUT_OF_RESOURCE error is set

    Returns:
  void drmaa2_queueinfo_free (drmaa2_queueinfo * qiRef)
       This DRMAA2_SUCCESSfunction iffrees succeeds DRMAA2_UNSUPPORTED_OPERATION error if failsthe pre-allocated drmaa queueinfo structure.

   drmaa2_rinfo drmaa2_rinfo_create (void)  Parameters:
      drmaa2_rinfo_create() - creates a drmaa2_reservation infoqiRef structure- andPointer returnsto itsdrmaa pointerqueueinfo

       Side-Effects: none

       Returns:
           drmaa2_rinfovoid
-
pointer to newly allocateddrmaa2_string_list drmaa2_rinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set_queueinfo_impl_spec (void)
       drmaa2_queueinfo_impl_spec - Lists the queue info spec implementations supported

   void drmaa2_rinfo_free (drmaa2_rinfo * riRef)
 Side-Effects: none

     This function freesReturns:
the pre-allocated drmaa rinfo structure.       drmaa2_string_list -list Parameters:of queueinfo spec implementations supported NULL - If this feature is not riRefsupported, - Pointerset drmaa2_lasterror_v to drmaaDRMAA2_UNSUPPORTED_OPERATION
reservation
info   void drmaa2_r_free (drmaa2_r * r)
 Side-Effects: none drmaa2_string drmaa2_r_get_id (const drmaa2_r r)
   Returns:    Get the reservation id from a given reservation voidobject.

   drmaa2_string_list drmaa2_rinfo_impl_spec (void)   Parameters:
    Lists the drmaa spec implementations supported for reservationr info (e.g. drmaa, drmaa2)- given reservation object

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

       Return values:
           - reservation id

   voiddrmaa2_rinfo drmaa2_r_rsessionget_freeinfo (const drmaa2_rsessionr * rsr)
       drmaa2_rsession_free FreesGet the memoryreservation ofinfo Reservationfrom sessiona pointedgiven byreservation rsobject.

       Parameters:
           rsr - pointergiven to drmaa2_rsession.reservation object

       Side-Effects: none

       Returns:
           drmaa2_rinfo - reservation info object NULL -  voidif fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_stringrtemplate drmaa2_rsessionr_get_reservation_contacttemplate (const drmaa2_rsessionr rsr)
       Get the reservation contacttemplate offrom a given drmaa2 reservation sessionobject.

       Parameters:
           rsr - given reservation sessionobject

       Side-Effects: none

       Returns:
           drmaa2_stringrtemplate- - contact name associated with reservation sessiontemplate NULL - if reservationfails session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSIONand DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_rstring drmaa2_rsessionr_get_session_reservationname (const drmaa2_rsession rs, const drmaa2_string reservationIdr r)
       Get the reservation objectsession name from a specific reservation session with the given reservation idobject.

       Parameters:
           rsr - given reservation session
           reservationId - given reservation idobject

          Side-Effects: none

       Returns:
           drmaa2_r- reservation NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION
-Effects: none

       Returns:
           ·drmaa2_string if- reservation session idname isNULL invalid, drmaa2_lasterror_v set to- if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_r_listerror drmaa2_rsessionr_get_reservationsterminate (const drmaa2_rsessionr rs_r)
       Get all the reservation objects from Terminate a specificgiven reservation session.

       Parameters:
           rs_r - given reservation sessionobject

       Side-Effects: none

       Returns:
           drmaa2_r_listerror - reservationon interfacesuccess list NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSIONDRMAA2_SUCCESS DRMAA2_DENIED_BY_DRMS if failed

   drmaa2_stringerror drmaa2_rsessionregister_getevent_session_namenotification (const drmaa2_rsession rs)
       Get the session name of a given drmaa2 reservation sessioncallback callback)
       Registers a drmaa2_callback with the DRMS library. For the first phase of implementation we do not support this.

       Parameters:
           rscallback - givena reservationstructure sessionof type drmaa2_callback containing the details of callback  Side-Effects: nonefunction, event etc

       ReturnsSide-Effects: none

       Returns:
  drmaa2_string - session name associated with reservation session NULL -DRMAA2_SUCCESS if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSIONsucceeds DRMAA2_UNSUPPORTED_OPERATION error if fails

   drmaa2_rrinfo drmaa2_rsessionrinfo_request_reservation (const drmaa2_rsession rs, const drmaa2_rtemplate rt_)
       Creates a reservation object in a specific reservation session with the given reservation template. it also evaluates reservation template for the mandatory attributes and sends the requestcreate (void)
        drmaa2_rinfo_create() - creates a drmaa2_reservation info structure and returns its pointer

       to DRMS.Side-Effects: none

       ParametersReturns:
           rsdrmaa2_rinfo - givenpointer reservationto sessionnewly allocated drmaa2_rinfo structure NULL - if allocation fails    rt_ - given reservation templateand DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_rinfo_free (drmaa2_rinfo * riRef)
Side-Effects: none      This function frees Returns:the pre-allocated drmaa rinfo structure.

      drmaa2_r- reservation NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

      Parameters:
           riRef - Pointer to drmaa reservation info

    · if reservation template evaluation fails, drmaa2_lasterror_v set to DRMAA2_UNSUPPORTED_ATTRIBUTESide-Effects: none

       Returns:
  · if DRMS rejects reservation request, drmaa2_lasterror_v set to DRMAA2_DENIED_BY_DRMS void

   drmaa2_string_rtemplatelist drmaa2_rinfo_rtemplateimpl_createspec (void)
       Lists Thisthe drmaa functionspec freesimplementations thesupported pre-allocatedfor drmaareservation rtemplate structure.info (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_rtemplate_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_rtemplatersession_free (drmaa2_rtemplatersession * rtrs)
       drmaa2_rsession_free Frees Thisthe functionmemory freesof theReservation pre-allocatedsession drmaapointed rtemplateby structure.rs

       Parameters:
           rtrs - Pointerpointer to drmaa rtemplatedrmaa2_rsession.

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_rtemplatersession_implget_speccontact (voidconst drmaa2_rsession rs)
       ListsGet the drmaacontact specof implementationsa supportedgiven fordrmaa2 reservation template (e.gsession.
drmaa,
drmaa2)       Parameters:
 Side-Effects: none         Returns:rs - given reservation session

      drmaa2_string_list Side-Effects: listnone
of
drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATIONReturns:
          drmaa2_error drmaa2_set_instance_value (void * instance, const char * name, const char * value)
   void drmaa2_slotinfo_free (drmaa2_slotinfo * siRef)
       This function frees the pre-allocated drmaa slotinfo.

       Parameters:string - contact name associated with reservation session NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

   drmaa2_r drmaa2_rsession_get_reservation (const drmaa2_rsession rs, const drmaa2_string reservationId)
       Get the reservation object from siRefa -specific Pointerreservation tosession drmaawith slotinfothe given reservation id.

    Side-Effects: none  Parameters:
      Returns:     rs - given reservation session
  void     void drmaa2_string_free (drmaa2_string * str)reservationId - given reservation id

  This function frees the previously allocated drmaa2_string.Side-Effects: none

       ParametersReturns:
           str drmaa2_r- pointerreservation toNULL pre- allocatedif drmaa2_stringreservation session is invalid, drmaa2_lasterror_v set    Side-Effects: noneto DRMAA2_INVALID_SESSION

        Returns:   · if reservation id is invalid, drmaa2_lasterror_v set to voidDRMAA2_INVALID_ARGUMENT

   drmaa2_boolr_list drmaa2_rsession_get_supportsreservations (const drmaa2_capabilityrsession crs_)
       drmaa2_supportsGet -all returnsthe truereservation ifobjects drmaafrom supportsa thespecific provided drmaa2_capabilityreservation session.

       Parameters:
           crs_ - drmaa2_capabilitygiven enumreservation valuesession

       Side-Effects: none

       Returns:
           drmaa2_versionr_list - reservation interface list NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

   voiddrmaa2_string drmaa2_rsession_versionget_session_freename (const drmaa2_versionrsession rs)
* vRef)      Get the Thissession functionname freesof thea pre-allocatedgiven drmaadrmaa2 versionreservation structuresession.

       Parameters:
           vRefrs - Pointergiven toreservation drmaasession
version
        Side-Effects: none

       Returns:
 
         void