ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/libstatgrab/docs/load_average.txt
Revision: 1.3
Committed: Thu Oct 2 16:30:54 2003 UTC (20 years, 7 months ago) by tdb
Content type: text/plain
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +1 -1 lines
State: FILE REMOVED
Log Message:
Dropped the old text documentation in favour of manpages.

File Contents

# Content
1 Load Averages
2 =============
3
4 $Id: load_average.txt,v 1.2 2003/08/24 20:24:08 tdb Exp $
5
6 Data Structure
7 --------------
8
9 The structure returned is of type load_stat_t and looks like this:
10
11 typedef struct{
12 double min1;
13 double min5;
14 double min15;
15 }load_stat_t;
16
17 min1 The load average over 1 minute.
18 min5 The load average over 5 minutes.
19 min15 The load average over 15 minutes.
20
21 Functions
22 ---------
23
24 load_stat_t *get_load_stats();
25
26 This call returns a static buffer of load_stat_t.
27
28 On most systems this function is just a wrapper to the getloadavg
29 system call.
30
31 Example
32 -------
33
34 An example can be found in examples/load_stats.c