libstatgrab/docs/sg_get_process_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_process_stats">

  <refentryinfo>
    <date>$Date: 2004/05/02 09:35:15 $</date>
    <releaseinfo>$Id: sg_get_process_stats.xml,v 1.4 2004/05/02 09:35:15 tdb Exp $</releaseinfo>
  </refentryinfo>

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

  <refnamediv>
    <refname>sg_get_process_count</refname>
    <refpurpose>get process statistics</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>sg_process_count *<function>sg_get_process_count</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <function>sg_get_process_count</function> returns a pointer to a
      static buffer of type <structname>sg_process_count</structname>.
    </para>
    <para>
      It provides information on the number of processes and the
      system and the different states they're in.
    </para>
  </refsect1>

  <refsect1>
    <title>Return Values</title>

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

    <programlisting>
typedef struct{
        int total;
        int running;
        int sleeping;
        int stopped;
        int zombie;
}sg_process_count;
    </programlisting>

    <variablelist>
      <varlistentry>
        <term><structfield>total</structfield></term>
        <listitem>
          <para>
            The total number of processes.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>running</structfield></term>
        <listitem>
          <para>
            The number of running processes.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>sleeping</structfield></term>
        <listitem>
          <para>
            The number of sleeping processes.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>stopped</structfield></term>
        <listitem>
          <para>
            The number of stopped processes.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>zombie</structfield></term>
        <listitem>
          <para>
            The number of zombie processes.
          </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.5
Committed:	Sun May 2 17:21:35 2004 UTC (20 years, 6 months ago) by tdb
Content type:	text/xml
Branch:	MAIN
Changes since 1.4:	+17 -17 lines
Log Message:	First pass as updating contents of documentation.
#	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_process_stats">
7	tdb	1.1
8			<refentryinfo>
9	tdb	1.5	<date>$Date: 2004/05/02 09:35:15 $</date>
10			<releaseinfo>$Id: sg_get_process_stats.xml,v 1.4 2004/05/02 09:35:15 tdb Exp $</releaseinfo>
11	tdb	1.1	</refentryinfo>
12	tdb	1.5
13	tdb	1.1	<refmeta>
14	tdb	1.5	<refentrytitle>sg_get_process_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_process_count</refname>
21	tdb	1.1	<refpurpose>get process statistics</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_process_count *<function>sg_get_process_count</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	tdb	1.5	<function>sg_get_process_count</function> returns a pointer to a
38			static buffer of type <structname>sg_process_count</structname>.
39	tdb	1.1	</para>
40			<para>
41			It provides information on the number of processes and the
42			system and the different states they're in.
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_process_count</structname>.
52	tdb	1.1	</para>
53
54			<programlisting>
55			typedef struct{
56			int total;
57			int running;
58			int sleeping;
59			int stopped;
60			int zombie;
61	tdb	1.5	}sg_process_count;
62	tdb	1.1	</programlisting>
63
64			<variablelist>
65			<varlistentry>
66			<term><structfield>total</structfield></term>
67			<listitem>
68			<para>
69			The total number of processes.
70			</para>
71			</listitem>
72			</varlistentry>
73			<varlistentry>
74			<term><structfield>running</structfield></term>
75			<listitem>
76			<para>
77			The number of running processes.
78			</para>
79			</listitem>
80			</varlistentry>
81			<varlistentry>
82			<term><structfield>sleeping</structfield></term>
83			<listitem>
84			<para>
85			The number of sleeping processes.
86			</para>
87			</listitem>
88			</varlistentry>
89			<varlistentry>
90			<term><structfield>stopped</structfield></term>
91			<listitem>
92			<para>
93			The number of stopped processes.
94			</para>
95			</listitem>
96			</varlistentry>
97			<varlistentry>
98			<term><structfield>zombie</structfield></term>
99			<listitem>
100			<para>
101			The number of zombie processes.
102			</para>
103			</listitem>
104			</varlistentry>
105			</variablelist>
106			</refsect1>
107
108			<refsect1>
109			<title>See Also</title>
110	tdb	1.2
111			<simplelist type="inline">
112			<member>
113			<citerefentry>
114			<refentrytitle>statgrab</refentrytitle>
115			<manvolnum>3</manvolnum>
116			</citerefentry>
117			</member>
118			</simplelist>
119	tdb	1.1	</refsect1>
120	tdb	1.5
121	tdb	1.1	<refsect1>
122			<title>Website</title>
123	tdb	1.5
124	tdb	1.1	<simplelist type="vert">
125			<member>
126	tdb	1.3	<ulink url="http://www.i-scream.org/libstatgrab/">
127			http://www.i-scream.org/libstatgrab/
128			</ulink>
129	tdb	1.1	</member>
130			</simplelist>
131			</refsect1>
132
133			</refentry>