1PMDANAME(3)                Library Functions Manual                PMDANAME(3)
2
3
4

NAME

6       pmdaName  -  translate  a  PMID  to a set of dynamic performance metric
7       names
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11       #include <pcp/impl.h>
12       #include <pcp/pmda.h>
13
14       int pmdaName(pmID pmid, char ***nameset, pmdaExt *pmda);
15
16       cc ... -lpcp_pmda -lpcp
17

DESCRIPTION

19       As part of  the  Performance  Metrics  Domain  Agent  (PMDA)  API  (see
20       PMDA(3)),  pmdaName is the generic callback for translating a pmid into
21       one or more dynamic metric names (nameset).
22
23       Because implementing dynamic performance metrics requires specific PMDA
24       support,  and  the  facility  is  an optional component of a PMDA (most
25       PMDAs do not support dynamic performance metrics), pmdaName is a skele‐
26       ton implementation that returns PM_ERR_NAME.
27
28       A PMDA that supports dynamic performance metrics will provide a private
29       callback that replaces pmdaName (by assignment to version.four.name  of
30       the pmdaInterface structure) and implements the translation from a pmid
31       to a set of dynamic performance metric names returned via nameset.  The
32       behaviour,  return  values  and memory allocation rules for nameset are
33       the same as for pmNameAll(3).
34

DIAGNOSTICS

36       pmdaName returns PM_ERR_PMID if the name is not recognized or cannot be
37       translated,  otherwise  the number of metric names found (most commonly
38       1).
39

CAVEAT

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

SEE ALSO

45       PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3), pmdaMain(3), pmNameAll(3)
46       and pmNameID(3).
47
48
49
50Performance Co-Pilot                  PCP                          PMDANAME(3)
Impressum