pbs_statsched(3B)

NAME
pbs_statsched - obtain status of PBS scheduler

SYNOPSIS
#include <pbs_error.h>
#include <pbs_ifl.h>

struct batch_status *pbs_statsched(int connect, struct attrl *attrib, char *extend)

void pbs_statfree(struct batch_status *psj)

DESCRIPTION
Issue a batch request to obtain the status of PBS scheduler.

A Status Scheduler batch request is generated and sent to the server. The parameter connect is the return value of pbs_connect().

The parameter, attrib , is a pointer to an attrl structure which is defined in pbs_ifl.h as:

    struct attrl {
        struct attrl *next;
        char         *name;
        char         *resource;
        char         *value;
    };

The attrib list is terminated by the first entry where next is a null pointer. If attrib is given, then only the attributes in the list are returned by the server. Otherwise, all the attributes of the scheduler are returned. When an attrib list is specified, the name member is a pointer to an attribute name as listed in pbs_alter(3) and pbs_submit(3). The resource member is only used if the name member is ATTR_l, otherwise it should be a pointer to a null string. The value member should always be a pointer to a null string.

The parameter, extend , is reserved for implementation-defined extensions.

The return value of pbs_statsched() is a pointer to a list of batch_status structures, which is defined in pbs_ifl.h as:

    struct batch_status {
        struct batch_status *next;
        char                *name;
        struct attrl        *attribs;
        char                *text;
    }

It is up the user to free the batch_status structure when it is no longer needed, by calling pbs_statfree().

SEE ALSO
qstat(1B) and pbs_connect(3B)

DIAGNOSTICS
When the batch request generated by pbs_statsched() has been completed successfully by the PBS server, pbs_statsched() will return a pointer to a batch_status structure. Otherwise, a null pointer is returned and the error code is set in pbs_errno.