libstatgrab/docs/sg_get_load_stats.xml

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="get_load_stats">

  <refentryinfo>
    <date>$Date: 2003/10/01 13:47:56 $</date>
    <releaseinfo>$Id: get_load_stats.xml,v 1.1 2003/10/01 13:47:56 tdb Exp $</releaseinfo>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>get_load_stats</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>i-scream</refmiscinfo>
  </refmeta>
  
  <refnamediv>
    <refname>get_load_stats</refname>
    <refpurpose>get system load</refpurpose>
  </refnamediv>
    
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>load_stat_t *<function>get_load_stats</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      This call returns a pointer to a static buffer of
      <structname>load_stat_t</structname>.
    </para>
    <para>
      On most systems this function is just a wrapper to the
      <function>getloadavg</function> system call.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Return Values</title>

    <para>
      The structure returned is of type
      <structname>load_stat_t</structname>.
    </para>

    <programlisting>
typedef struct{
        double min1;
        double min5;
        double min15;
}load_stat_t;
    </programlisting>

    <variablelist>
      <varlistentry>
        <term><structfield>min1</structfield></term>
        <listitem>
          <para>
            The load average over 1 minute.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>min5</structfield></term>
        <listitem>
          <para>
            The load average over 5 minutes.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>min15</structfield></term>
        <listitem>
          <para>
            The load average over 15 minutes.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simplelist type="inline">
      <member>
        <citerefentry>
          <refentrytitle>statgrab</refentrytitle>
          <manvolnum>3</manvolnum>
        </citerefentry>
      </member>
    </simplelist>
  </refsect1>
  
  <refsect1>
    <title>Website</title>
    
    <simplelist type="vert">
      <member>
        <ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink>
      </member>
    </simplelist>
  </refsect1>

</refentry>
Revision:	1.2
Committed:	Thu Oct 2 17:38:03 2003 UTC (21 years, 1 month ago) by tdb
Content type:	text/xml
Branch:	MAIN
CVS Tags:	LIBSTATGRAB_0_9, LIBSTATGRAB_0_8_2, LIBSTATGRAB_0_8_1, LIBSTATGRAB_0_8, LIBSTATGRAB_0_7, LIBSTATGRAB_0_6_1, LIBSTATGRAB_0_6
Changes since 1.1:	+11 -3 lines
Log Message:	Add a central page statgrab(3) which links all the functions together. Add a link in the See Also section of each manual page back to the central one.
#	User	Rev	Content
1	tdb	1.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	tdb	1.2	<date>$Date: 2003/10/01 13:47:56 $</date>
10			<releaseinfo>$Id: get_load_stats.xml,v 1.1 2003/10/01 13:47:56 tdb Exp $</releaseinfo>
11	tdb	1.1	</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	tdb	1.2
93			<simplelist type="inline">
94			<member>
95			<citerefentry>
96			<refentrytitle>statgrab</refentrytitle>
97			<manvolnum>3</manvolnum>
98			</citerefentry>
99			</member>
100			</simplelist>
101	tdb	1.1	</refsect1>
102
103			<refsect1>
104			<title>Website</title>
105
106			<simplelist type="vert">
107			<member>
108			<ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink>
109			</member>
110			</simplelist>
111			</refsect1>
112
113			</refentry>