summaryrefslogtreecommitdiff
path: root/man/man3/pmdaprofile.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/pmdaprofile.3')
-rw-r--r--man/man3/pmdaprofile.359
1 files changed, 59 insertions, 0 deletions
diff --git a/man/man3/pmdaprofile.3 b/man/man3/pmdaprofile.3
new file mode 100644
index 0000000..0f64da3
--- /dev/null
+++ b/man/man3/pmdaprofile.3
@@ -0,0 +1,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).