pmdasenderror(3) — Linux manual page

NAME | C SYNOPSIS | PYTHON SYNOPSIS | DESCRIPTION | SEE ALSO | COLOPHON

PMDASENDERROR(3)        Library Functions Manual        PMDASENDERROR(3)

NAME         top

       pmdaSendError - send an error PDU to PMCD

C SYNOPSIS         top

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

       void pmdaSendError(pmdaInterface *dispatch, int err);

       cc ... -lpcp_pmda -lpcp

PYTHON SYNOPSIS         top

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

DESCRIPTION         top

       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         top

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

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to pcp@groups.io.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2021-06-20.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-06-19.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Performance Co-Pilot               PCP                  PMDASENDERROR(3)

Pages that refer to this page: pmda(3)