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"> |
6 |
> |
<refentry id="sg_get_load_stats"> |
7 |
|
|
8 |
|
<refentryinfo> |
9 |
|
<date>$Date$</date> |
10 |
|
<releaseinfo>$Id$</releaseinfo> |
11 |
|
</refentryinfo> |
12 |
< |
|
12 |
> |
|
13 |
|
<refmeta> |
14 |
< |
<refentrytitle>get_load_stats</refentrytitle> |
14 |
> |
<refentrytitle>sg_get_load_stats</refentrytitle> |
15 |
|
<manvolnum>3</manvolnum> |
16 |
|
<refmiscinfo>i-scream</refmiscinfo> |
17 |
|
</refmeta> |
18 |
< |
|
18 |
> |
|
19 |
|
<refnamediv> |
20 |
< |
<refname>get_load_stats</refname> |
20 |
> |
<refname>sg_get_load_stats</refname> |
21 |
|
<refpurpose>get system load</refpurpose> |
22 |
|
</refnamediv> |
23 |
< |
|
23 |
> |
|
24 |
|
<refsynopsisdiv> |
25 |
|
<funcsynopsis> |
26 |
|
<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo> |
27 |
|
<funcprototype> |
28 |
< |
<funcdef>load_stat_t *<function>get_load_stats</function></funcdef> |
28 |
> |
<funcdef>sg_load_stats *<function>sg_get_load_stats</function></funcdef> |
29 |
|
<void/> |
30 |
|
</funcprototype> |
31 |
|
</funcsynopsis> |
32 |
|
</refsynopsisdiv> |
33 |
< |
|
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>. |
38 |
> |
<structname>sg_load_stats</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 |
< |
|
45 |
> |
|
46 |
|
<refsect1> |
47 |
|
<title>Return Values</title> |
48 |
|
|
49 |
|
<para> |
50 |
|
The structure returned is of type |
51 |
< |
<structname>load_stat_t</structname>. |
51 |
> |
<structname>sg_load_stats</structname>. |
52 |
|
</para> |
53 |
|
|
54 |
|
<programlisting> |
55 |
|
typedef struct{ |
56 |
< |
double min1; |
57 |
< |
double min5; |
58 |
< |
double min15; |
59 |
< |
}load_stat_t; |
56 |
> |
double min1; |
57 |
> |
double min5; |
58 |
> |
double min15; |
59 |
> |
}sg_load_stats; |
60 |
|
</programlisting> |
61 |
|
|
62 |
|
<variablelist> |
89 |
|
|
90 |
|
<refsect1> |
91 |
|
<title>See Also</title> |
92 |
< |
<para>Nothing yet</para> |
92 |
> |
|
93 |
> |
<simplelist type="inline"> |
94 |
> |
<member> |
95 |
> |
<citerefentry> |
96 |
> |
<refentrytitle>statgrab</refentrytitle> |
97 |
> |
<manvolnum>3</manvolnum> |
98 |
> |
</citerefentry> |
99 |
> |
</member> |
100 |
> |
</simplelist> |
101 |
|
</refsect1> |
102 |
< |
|
102 |
> |
|
103 |
|
<refsect1> |
104 |
|
<title>Website</title> |
105 |
< |
|
105 |
> |
|
106 |
|
<simplelist type="vert"> |
107 |
|
<member> |
108 |
< |
<ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink> |
108 |
> |
<ulink url="http://www.i-scream.org/libstatgrab/"> |
109 |
> |
http://www.i-scream.org/libstatgrab/ |
110 |
> |
</ulink> |
111 |
|
</member> |
112 |
|
</simplelist> |
113 |
|
</refsect1> |