| 1 |
<?xml version="1.0"?> |
| 2 |
|
| 3 |
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 4 |
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 5 |
|
| 6 |
<refentry id="get_load_stats"> |
| 7 |
|
| 8 |
<refentryinfo> |
| 9 |
<date>$Date$</date> |
| 10 |
<releaseinfo>$Id$</releaseinfo> |
| 11 |
</refentryinfo> |
| 12 |
|
| 13 |
<refmeta> |
| 14 |
<refentrytitle>get_load_stats</refentrytitle> |
| 15 |
<manvolnum>3</manvolnum> |
| 16 |
<refmiscinfo>i-scream</refmiscinfo> |
| 17 |
</refmeta> |
| 18 |
|
| 19 |
<refnamediv> |
| 20 |
<refname>get_load_stats</refname> |
| 21 |
<refpurpose>get system load</refpurpose> |
| 22 |
</refnamediv> |
| 23 |
|
| 24 |
<refsynopsisdiv> |
| 25 |
<funcsynopsis> |
| 26 |
<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo> |
| 27 |
<funcprototype> |
| 28 |
<funcdef>load_stat_t *<function>get_load_stats</function></funcdef> |
| 29 |
<void/> |
| 30 |
</funcprototype> |
| 31 |
</funcsynopsis> |
| 32 |
</refsynopsisdiv> |
| 33 |
|
| 34 |
<refsect1> |
| 35 |
<title>Description</title> |
| 36 |
<para> |
| 37 |
This call returns a pointer to a static buffer of |
| 38 |
<structname>load_stat_t</structname>. |
| 39 |
</para> |
| 40 |
<para> |
| 41 |
On most systems this function is just a wrapper to the |
| 42 |
<function>getloadavg</function> system call. |
| 43 |
</para> |
| 44 |
</refsect1> |
| 45 |
|
| 46 |
<refsect1> |
| 47 |
<title>Return Values</title> |
| 48 |
|
| 49 |
<para> |
| 50 |
The structure returned is of type |
| 51 |
<structname>load_stat_t</structname>. |
| 52 |
</para> |
| 53 |
|
| 54 |
<programlisting> |
| 55 |
typedef struct{ |
| 56 |
double min1; |
| 57 |
double min5; |
| 58 |
double min15; |
| 59 |
}load_stat_t; |
| 60 |
</programlisting> |
| 61 |
|
| 62 |
<variablelist> |
| 63 |
<varlistentry> |
| 64 |
<term><structfield>min1</structfield></term> |
| 65 |
<listitem> |
| 66 |
<para> |
| 67 |
The load average over 1 minute. |
| 68 |
</para> |
| 69 |
</listitem> |
| 70 |
</varlistentry> |
| 71 |
<varlistentry> |
| 72 |
<term><structfield>min5</structfield></term> |
| 73 |
<listitem> |
| 74 |
<para> |
| 75 |
The load average over 5 minutes. |
| 76 |
</para> |
| 77 |
</listitem> |
| 78 |
</varlistentry> |
| 79 |
<varlistentry> |
| 80 |
<term><structfield>min15</structfield></term> |
| 81 |
<listitem> |
| 82 |
<para> |
| 83 |
The load average over 15 minutes. |
| 84 |
</para> |
| 85 |
</listitem> |
| 86 |
</varlistentry> |
| 87 |
</variablelist> |
| 88 |
</refsect1> |
| 89 |
|
| 90 |
<refsect1> |
| 91 |
<title>See Also</title> |
| 92 |
<para>Nothing yet</para> |
| 93 |
</refsect1> |
| 94 |
|
| 95 |
<refsect1> |
| 96 |
<title>Website</title> |
| 97 |
|
| 98 |
<simplelist type="vert"> |
| 99 |
<member> |
| 100 |
<ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink> |
| 101 |
</member> |
| 102 |
</simplelist> |
| 103 |
</refsect1> |
| 104 |
|
| 105 |
</refentry> |
