18.2.3. PMIx_Initialized

PMIx_Initialized — Determine whether the PMIx library has been initialized.

18.2.3.1. SYNOPSIS

#include <pmix.h>

int PMIx_Initialized(void);

18.2.3.1.1. Python Syntax

from pmix import *

foo = PMIxClient()
state = foo.initialized()

18.2.3.2. DESCRIPTION

Check whether the PMIx library has been initialized by any of the initialization functions — PMIx_Init(3), PMIx_server_init, or PMIx_tool_init. This function may be called outside of the initialized and finalized region, and is usable by servers and tools in addition to clients.

The function only reports the internal state of the PMIx library. It does not verify that an active connection with the local server exists, nor that the server is functional.

18.2.3.3. RETURN VALUE

Returns 1 (true) if the PMIx library has been initialized, and 0 (false) otherwise.

Note

The return value is an int rather than a bool for historical reasons: this matches the signature of prior PMI libraries.