docs/libstatgrab/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="sg_get_load_stats">

  <refentryinfo>
    <date>$Date: 2004/05/02 17:21:35 $</date>
    <releaseinfo>$Id: sg_get_load_stats.xml,v 1.5 2004/05/02 17:21:35 tdb Exp $</releaseinfo>
  </refentryinfo>

  <refmeta>
    <refentrytitle>sg_get_load_stats</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>i-scream</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>sg_get_load_stats</refname>
    <refpurpose>get system load</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>sg_load_stats *<function>sg_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>sg_load_stats</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>sg_load_stats</structname>.
    </para>

    <programlisting>
typedef struct{
        double min1;
        double min5;
        double min15;
}sg_load_stats;
    </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/libstatgrab/">
          http://www.i-scream.org/libstatgrab/
        </ulink>
      </member>
    </simplelist>
  </refsect1>

</refentry>
Revision:	1.6
Committed:	Mon Apr 25 11:25:45 2005 UTC (19 years ago) by tdb
Content type:	text/xml
Branch:	MAIN
CVS Tags:	LIBSTATGRAB_0_17, LIBSTATGRAB_0_16, LIBSTATGRAB_0_15, LIBSTATGRAB_0_14, LIBSTATGRAB_0_13, LIBSTATGRAB_0_12, HEAD
Changes since 1.5:	+2 -2 lines
Log Message:	Move by repocopy the libstatgrab docs in to a subdirectory. This is so I can create separate directories for statgrab/saidar docs.
#	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	tdb	1.5	<refentry id="sg_get_load_stats">
7	tdb	1.1
8			<refentryinfo>
9	tdb	1.6	<date>$Date: 2004/05/02 17:21:35 $</date>
10			<releaseinfo>$Id: sg_get_load_stats.xml,v 1.5 2004/05/02 17:21:35 tdb Exp $</releaseinfo>
11	tdb	1.1	</refentryinfo>
12	tdb	1.5
13	tdb	1.1	<refmeta>
14	tdb	1.5	<refentrytitle>sg_get_load_stats</refentrytitle>
15	tdb	1.1	<manvolnum>3</manvolnum>
16			<refmiscinfo>i-scream</refmiscinfo>
17			</refmeta>
18	tdb	1.5
19	tdb	1.1	<refnamediv>
20	tdb	1.5	<refname>sg_get_load_stats</refname>
21	tdb	1.1	<refpurpose>get system load</refpurpose>
22			</refnamediv>
23	tdb	1.5
24	tdb	1.1	<refsynopsisdiv>
25			<funcsynopsis>
26			<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo>
27			<funcprototype>
28	tdb	1.5	<funcdef>sg_load_stats *<function>sg_get_load_stats</function></funcdef>
29	tdb	1.1	<void/>
30			</funcprototype>
31			</funcsynopsis>
32			</refsynopsisdiv>
33	tdb	1.5
34	tdb	1.1	<refsect1>
35			<title>Description</title>
36			<para>
37			This call returns a pointer to a static buffer of
38	tdb	1.5	<structname>sg_load_stats</structname>.
39	tdb	1.1	</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	tdb	1.5
46	tdb	1.1	<refsect1>
47			<title>Return Values</title>
48
49			<para>
50			The structure returned is of type
51	tdb	1.5	<structname>sg_load_stats</structname>.
52	tdb	1.1	</para>
53
54			<programlisting>
55			typedef struct{
56	tdb	1.5	double min1;
57			double min5;
58			double min15;
59			}sg_load_stats;
60	tdb	1.1	</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	tdb	1.5
103	tdb	1.1	<refsect1>
104			<title>Website</title>
105	tdb	1.5
106	tdb	1.1	<simplelist type="vert">
107			<member>
108	tdb	1.3	<ulink url="http://www.i-scream.org/libstatgrab/">
109			http://www.i-scream.org/libstatgrab/
110			</ulink>
111	tdb	1.1	</member>
112			</simplelist>
113			</refsect1>
114
115			</refentry>