Scroll to navigation

PMIX_JOB_STATE_T(5) OpenPMIx PMIX_JOB_STATE_T(5)

pmix_job_state_t — Describes the execution state of a job

SYNTAX

C Syntax

#include <pmix_common.h>
typedef uint8_t pmix_job_state_t;
#define PMIX_JOB_STATE_UNDEF                     0
#define PMIX_JOB_STATE_AWAITING_ALLOC            1
#define PMIX_JOB_STATE_LAUNCH_UNDERWAY           2
#define PMIX_JOB_STATE_RUNNING                   3
#define PMIX_JOB_STATE_SUSPENDED                 4
#define PMIX_JOB_STATE_CONNECTED                 5
#define PMIX_JOB_STATE_UNTERMINATED             15
#define PMIX_JOB_STATE_TERMINATED               20
#define PMIX_JOB_STATE_TERMINATED_WITH_ERROR    50


DESCRIPTION

The pmix_job_state_t type is an 8-bit unsigned integer describing the execution state of a job. It takes one of the following values:

Undefined job state.
The job is waiting for resources to be allocated to it.
Job launch is underway.
All processes have been spawned.
The job has been suspended.
All processes have connected to their PMIx server.
A boundary value so users can easily and quickly determine whether a job is still running — any value less than this one means the job has not terminated.
The job has terminated and is no longer running — typically accompanied by the job exit status in response to a query.
The job has terminated and is no longer running — typically accompanied by a job-related error code in response to a query. This value also serves as a boundary so users can easily and quickly determine whether a job abnormally terminated.

The PMIx_Job_state_string(3) <#man3-pmix-job-state-string> function returns a string representation of a pmix_job_state_t value.

See also:

PMIx_Job_state_string(3) <#man3-pmix-job-state-string>, pmix_info_t(5) <#man5-pmix-info-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026