pmindomstr(3) [centos man page]

PMINDOMSTR(3)						     Library Functions Manual						     PMINDOMSTR(3)

NAME

       pmInDomStr, pmInDomStr_r - convert a performance metric instance domain identifier into a string

C SYNOPSIS

       #include <pcp/pmapi.h>

       const char *pmInDomStr(pmInDom indom);
       char *pmInDomStr_r(pmInDom indom, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION

       For  use  in  error and diagnostic messages, pmInDomStr return a 'human readable' version of the specified instance domain identifier.  The
       pmInDomStr_r function does the same, but stores the result in a user-supplied buffer buf of length buflen, which should have  room  for	at
       least 20 bytes.

       The  value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particu-
       lar performance metric.

       Internally, an instance domain identifier is encoded as follows;

	    typedef struct {
		int		pad:2;
		unsigned int	domain:8;	 /* the administrative PMD */
		unsigned int	serial:22;	 /* unique within PMD */
	    } __pmInDom_int;

       pmInDomStr returns a string with each of the domain and serial subfields appearing as decimal numbers, separated by periods.

       The string value returned by pmInDomStr is held in a single static buffer, so the returned value is only valid until the next call to pmIn-
       DomStr.

NOTES

       pmInDomStr returns a pointer to a static buffer and hence is not thread-safe.  Multi-threaded applications should use pmInDomStr_r instead.

PCP ENVIRONMENT

       Environment  variables  with  the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On each installation, the
       file /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative	configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmIDStr(3), pmLookupDesc(3), pcp.conf(5) and pcp.env(5).

Performance Co-Pilot							PCP							     PMINDOMSTR(3)

PMDAINSTANCE(3) 					     Library Functions Manual						   PMDAINSTANCE(3)

NAME

       pmdaInstance - return instance descriptions for a PMDA

C SYNOPSIS

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

       int pmdaInstance(pmInDom indom, int inst, char *name, __pmInResult **result, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION

       pmdaInstance uses the standard PMDA(3) data structures to return information concerning the instance domain indom.

       The result structure is constructed by pmdaInstance and will contain one or more instance names and/or identifiers as specified by the inst
       and name arguments.

       If inst has the value PM_IN_NULL and name is a null string, result will contain all the instances names and identifiers in the instance do-
       main.

       If  inst  is  PM_IN_NULL but name is the name of an instance in the instance domain indom, then result will contain the instance identifier
       for instance name.  Note that if name contains no spaces, partial matching up to the first space in the instance name  is  performed,  i.e.
       ``1''  will  match  instance  name ``1 minute''.  If name contains an embedded space, then no partial matching is performed and name should
       match one of the instance names exactly.

       If name is a null string but inst is an instance identifier in the instance domain indom, then result will contain the  name  for  instance
       inst.  The result structure is allocated with malloc(3) and should be released by the caller with free(3).

DIAGNOSTICS

       If  any	errors	occur during the execution of pmdaInstance, the result structure is deallocated.  If the instance domain indom is not sup-
       ported by the PMDA, pmdaInstance will return PM_ERR_INDOM.

       If the inst or name does not correspond to any instances in the indom domain, pmdaInstance will return PM_ERR_INST.

CAVEAT

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

       Because of optional partial matching up to the first space in the instance name, the PMDA developer should ensure that  if  instance  names
       are allowed to have spaces, the names are unique up to the first space.

SEE ALSO

       malloc(3), PMAPI(3), PMDA(3) and pmGetInDom(3).

Performance Co-Pilot							PCP							   PMDAINSTANCE(3)