pmdastore(3) — Linux manual page

NAME | C SYNOPSIS | DESCRIPTION | CAVEAT | DIAGNOSTICS | SEE ALSO | COLOPHON

PMDASTORE(3)            Library Functions Manual            PMDASTORE(3)

NAME         top

       pmdaStore - store a value into a metric for a PMDA

C SYNOPSIS         top

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

       int pmdaStore(pmResult *result, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION         top

       As part of the Performance Metrics Domain Agent (PMDA) API (see
       PMDA(3)), pmdaStore is the generic callback for storing a value
       into a metric.  pmdaStore is usually a no-op as, by default, no
       metrics can be altered.  Also, the implementation of a store
       callback which does permit metrics to be altered by pmstore(1) is
       very application dependent.

CAVEAT         top

       The PMDA must be using PMDA_PROTOCOL_2 or later, as specified in
       the call to pmdaDSO(3) or pmdaDaemon(3).

DIAGNOSTICS         top

       pmdaStore returns PM_ERR_PERMISSION to indicate that no metrics
       may be modified.

SEE ALSO         top

       pmstore(1), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3) and
       pmStore(3).

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 2023-12-22.
       (At that time, the date of the most recent commit that was found
       in the repository was 2023-12-16.)  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                      PMDASTORE(3)

Pages that refer to this page: pmda(3)pmdadaemon(3)pmdadso(3)pmdamain(3)