pbs_statserver (3) - Linux Man Pages

pbs_statserver: obtain status of a pbs batch server

NAME

pbs_statserver - obtain status of a pbs batch server

SYNOPSIS

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

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

void pbs_statfree(struct batch_status *psj)

DESCRIPTION

Issue a batch request to obtain the status of a batch server.

A Status Server batch request is generated and sent to the server over the connection specified by which is the return value of pbs_connect().

The parameter, 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 list is terminated by the first entry where is a null pointer. If is given, then only the attributes in the list are returned by the server. Otherwise, all the attributes of the server are returned. When an list is specified, the member is a pointer to a attribute name as listed in pbs_alter(3) and pbs_submit(3). The member is only used if the name member is ATTR_l, otherwise it should be a pointer to a null string. The member should aways be a pointer to a null string.

The parameter, is reserved for implementation defined extensions.

The return value 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 space when no longer needed, by calling pbs_statfree().

DIAGNOSTICS

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

SEE ALSO

qstat(1B) and pbs_connect(3B)