summaryrefslogtreecommitdiff
path: root/man/man3/pmdaprofile.3
blob: 0f64da3b4cb95c119ab9994f1578a8a5a2947d16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
'\"macro stdmacro
.\"
.\" Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
.\" 
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\" 
.\"
.TH PMDAPROFILE 3 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmdaProfile\f1 \- update instance profile for PMDA in preparation for the next fetch from PMCD
.SH "C SYNOPSIS"
.ft 3
#include <pcp/pmapi.h>
.br
#include <pcp/impl.h>
.br
#include <pcp/pmda.h>
.sp
int pmdaProfile(__pmProfile *\fIprof\fP, pmdaExt *\fIpmda\fP);
.sp
cc ... \-lpcp_pmda \-lpcp
.ft 1
.SH DESCRIPTION
As part of the Performance Metrics Domain Agent (PMDA) API (see
.BR PMDA (3)),
.B pmdaProfile
is the default callback which handles the receipt of a 
.B __pmProfile
from 
.BR pmcd (1).
A profile describes the instances that 
.B pmcd
requires in the 
.B pmResult
structure returned by the next fetch.
.B pmdaProfile
simply stores the new profile.
.SH CAVEAT
The PMDA must be using 
.B PMDA_PROTOCOL_2 
or later, as specified in the call to 
.BR pmdaDSO (3)
or 
.BR pmdaDaemon (3).
.SH SEE ALSO
.BR PMAPI (3),
.BR PMDA (3),
.BR pmdaDaemon (3),
.BR pmdaDSO (3)
and
.BR pmdaFetch (3).