pmdasenderror

C Synopsis

#include <pcp/pmapi.h>
#include <pcp/pmda.h>

void pmdaSendError(pmdaInterface *dispatch, int err);

cc ... -lpcp_pmda -lpcp

Python Synopsis

from pcp.pmda import PMDA
PMDA.pmda_notready()
PMDA.pmda_ready()

Description

As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), this routine allows a PMDA to send an error PDU to PMCD. There is presently only one use for this - so the PMDA can inform PMCD that it is ready (or not ready) to process requests.

The protocol details are described in pmcd(1) and PMDA(3), but basically if a PMDA starts in the notready state (as may be specified in pmcd.conf, see pmcd(1)) then PMCD will not send it any requests until the PMDA sends an PM_ERR_PMDAREADY error PDU using this function. This is used by a PMDA that may have a long startup time, e.g. to process a large configuration file or similar.

See Also

PMAPI(3), PMDA(3), pmcd(1), and pmdaprometheus(1).

Referenced By

PMDA(3).

The man page pmdasenderror(3) is an alias of pmdaSendError(3).