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

NAME

6       pmLookupInDom,  pmRequestInDomInst,  pmReceiveInDomInst  - translate an
7       instance name into an instance identifier
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmLookupInDom(pmInDom indom, const char *name)
13       int pmRequestInDomInst(int ctx, pmInDom indom, const char *name)
14       int pmReceiveInDomInst(int ctx)
15
16       cc ... -lpcp
17

DESCRIPTION

19       For the instance domain  indom,  in  the  current  Performance  Metrics
20       Application  Programming Interface (PMAPI) context, locate the instance
21       with the external identification given by name, and return the internal
22       instance identifier.
23
24       Only  the leading non-space characters of name will be used to identify
25       the instance.
26
27       The value for the instance domain indom is typically extracted  from  a
28       pmDesc  structure, following a call to pmLookupDesc(3) for a particular
29       performance metric.
30
31       pmLookupInDom will return a positive instance identifier on success.
32
33       pmRequestInDomInst and  pmReceiveInDomInst  are  used  by  applications
34       which  must  communicate with the PMCD asynchronously.  These functions
35       take explict context handle ctx which must  refer  to  a  host  context
36       (i.e. created by passing PM_CONTEXT_HOST to pmNewContext). pmRequestIn‐
37       DomInst sends request to translate external instance name  to  internal
38       instance  identifier  to  PMCD  and  returns  without  waiting  for the
39       response, pmReceiveInDomInst reads reply from PMCD. It is the responsi‐
40       bility  of the application to make sure the data are ready before call‐
41       ing pmReceiveInDomInst to avoid blocking.
42

SEE ALSO

44       PMAPI(3),  pmGetConfig(3),  pmGetInDom(3),  pmLookupDesc(3),  pmNameIn‐
45       Dom(3), pcp.conf(4) and pcp.env(4).
46

DIAGNOSTICS

48       PM_ERR_INDOM
49              indom is not a valid instance domain identifier
50
51       PM_ERR_INST
52              The  external instance name is not known for the instance domain
53              indom in the current PMAPI context
54
55       PM_ERR_CTXBUSY
56              Context is currently in use by another asynchronous call.
57
58
59
60Performance Co-Pilot                  SGI                     PMLOOKUPINDOM(3)
Impressum