Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Standard C Library Functionsgetloadavg(3C)


NAME

 getloadavg - get system load averages

SYNOPSIS

 
#include <sys/loadavg.h>
int getloadavg(double loadavg[], int nelem);

DESCRIPTION

 

The getloadavg() function returns the number of processes in the system run queue averaged over various periods of time. Up to nelem samples are retrieved and assigned to successive elements of loadavg[]. The system imposes a maximum of 3 samples, representing averages over the last 1, 5, and 15 minutes, respectively. The LOADAVG_1MIN, LOADAVG_5MIN, and LOADAVG_15MIN indices, defined in <sys/loadavg.h>, can be used to extract the data from the appropriate element of the loadavg[] array.

RETURN VALUES

 

Upon successful completion, the number of samples actually retrieved is returned. If the load average was unobtainable, -1 is returned and errno is set to indicate the error.

ERRORS

 

The getloadavg() function will fail if:

EINVAL
The number of elements specified is less than 0.

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelAsync-Signal-Safe

SEE ALSO

 

uptime(1), w(1), kstat(3KSTAT), standards(5)


SunOS 5.9Go To TopLast Changed 7 Jan 1998

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.