pmdaconnect(3) [centos man page]

PMDACONNECT(3)						     Library Functions Manual						    PMDACONNECT(3)

NAME

       pmdaConnect - establish a connection between a daemon PMDA and PMCD

C SYNOPSIS

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

       void pmdaConnect(pmdaInterface *dispatch);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION

       pmdaConnect  initializes  an IPC channel between a PMDA(3) and the pmcd(1) process on the local host.  The type of the connection is depen-
       dent on the e_io field of the pmdaExt structure:

       pmdaPipe       Use stdin/stdout to communicate; assumes this is a pipe created by pmcd before the PMDA(3) was launched.

       pmdaInet       Assume pmcd(1) will establish a connection to an IPv4 internet domain socket set up by the PMDA(3).  The name or	number	of
		      the port must be specified in the e_sockname or e_port fields of the pmdaExt structure, respectively.

       pmdaIPv6       Assume  pmcd(1)  will establish a connection to an IPv6 internet domain socket set up by the PMDA(3).  The name or number of
		      the port must be specified in the e_sockname or e_port fields of the pmdaExt structure, respectively.

       pmdaUnix       Assume pmcd(1) will establish a connection to a unix domain socket set up by the PMDA(3).  The port number must be specified
		      in the e_port field of the pmdaExt structure.

       pmdaUnknown    The initial value of e_io which defaults to using stdin/stdout.

       The  relevant  pmdaExt  fields  are  initialized by pmdaInit(3) and set by pmdaGetOpt(3), so most PMDAs should not need to access or modify
       them.

DIAGNOSTICS

       pmdaConnect will log the type of connection made to pmcd(1) if the PMAPI(3) debug control variable (pmDebug) has the DBG_TRACE_LIBPMDA flag
       set.

       If an error occurs that is unrecoverable, dispatch->status is set to a value less than 0, otherwise it is zero or positive.

CAVEAT

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

SEE ALSO

       pmcd(1), pipe(2), socket(2), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaGetOpt(3) and pmdaInit(3).

Performance Co-Pilot							PCP							    PMDACONNECT(3)

Check Out this Related Man Page

PMDATEXT(3)						     Library Functions Manual						       PMDATEXT(3)

NAME

       pmdaText - extract metric help text for a PMDA

C SYNOPSIS

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

       int pmdaText(int ident, int type, char **buffer, pmdaExt *pmda);

       cc ... -lpcp_pmda -lpcp

DESCRIPTION

       As  part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaText uses the standard PMDA(3) data structures to return the
       help text for metric ident in buffer.  The help text must be located in help text files created with newhelp(1), and the  associated  files
       are automatically opened by pmdaInit(3).

       The  path  to the (basename of the) help text files can be set in the calls to pmdaDSO(3) or pmdaDaemon(3) and overridden by the -h command
       line option in pmdaGetOpt(3).

       The encoding of ident follows the internal scheme used below the routines pmLookupText(3) and pmLookupInDomText(3),  namely  ident  encodes
       either a metric identifier or an instance domain identifier, according to the value of type.

       The  type  argument  is	a  bit	mask  that  encodes  the  interpretation  of ident and the requested form of help text, as follows: either
       PM_TEXT_PMID if ident is a metric identifier, or PM_TEXT_INDOM if ident is an instance domain identifier, plus either  PM_TEXT_ONELINE  for
       the one line help text or PM_TEXT_HELP for the full help text.

       The buffer is managed internally (usually it is cached), and it should not be released or freed by the caller of pmdaText.

DIAGNOSTICS

       If the requested help text could not be obtained, pmdaText will return PM_ERR_TEXT.

CAVEAT

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

SEE ALSO

       newhelp(1), malloc(3), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3), pmdaInit(3), pmLookupInDomText(3) and pmLookupText(3).

Performance Co-Pilot							PCP							       PMDATEXT(3)

Linux and UNIX Man Pages

pmdaconnect(3) [centos man page]

Check Out this Related Man Page