gkemu.h File Reference

---

Detailed Description

Header file for GKrellmd (http://www.gkrellm.net) emulation functions.

GKrellm is a system monitoring utility that displays the current system state in a nice GUI. Fortunately, it supports a client/server mode that uses a simple network protocol for communicating the system state. So, instead of sending the entire state of the system back to the GUI client, we send back the state of a TimeSys resource set. The following monitors are supported:

• HostName The name of the resource set.
• SystemName The name of the executable.
• CPU_0 The CPU usage for all the processes in the set.
• CPU_1 The CPU reservation for the resource set and the amount of the reservation that is currently in use.
• UpTime The length of time rktimes(1) has been running.
• Proc The number of processes in the resource set.

Definition in file gkemu.h.

Include dependency graph for gkemu.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	gka_tag_t {   GKA_TAG_DONE, GKA_HostName, GKA_SystemName, GKA_CPUUser,   GKA_CPUIdle, GKA_CPUReserveUser, GKA_CPUReserveNice, GKA_CPUReserveIdle,   GKA_UpTime, GKA_Processes, GKA_ProcessesRunning }
	Argument tags for the functions. More...
Functions
int	gkFormatPreamble (char *buf, size_t buf_len, gka_tag_t tag,...)
	Format the preamble into the given buffer.
int	gkFormatUpdate (char *buf, size_t buf_len, gka_tag_t tag,...)
	Format an update into the given buffer.
Variables
const char *	gkInitialUpdateOpen
	Tag string used to mark the beginning of the "initial update".
const char *	gkInitialUpdateClose
	Tag string used to mark the end of the "initial update".

---

Enumeration Type Documentation

enum gka_tag_t

Argument tags for the functions. Enumeration values: GKA_TAG_DONE  () - Terminate the tag list GKA_HostName  (char *) - Host name GKA_SystemName  (char *) - System name GKA_CPUUser  (unsigned long long) - User time CPU usage GKA_CPUIdle  (unsigned long long) - CPU idle time GKA_CPUReserveUser  (unsigned long long) - CPU reserve GKA_CPUReserveNice  (unsigned long long) - CPU reserve consumed GKA_CPUReserveIdle  (unsigned long long) - CPU not reserved GKA_UpTime  (struct timeval *) - Process running time GKA_Processes  (unsigned int) - Number of processes in the set GKA_ProcessesRunning  (unsigned int) - Number of running processes in the set Definition at line 44 of file gkemu.h. Referenced by gkFormatPreamble(), and gkFormatUpdate().

---

Function Documentation

int gkFormatPreamble (  char *  buf, size_t  buf_len, gka_tag_t  tag,   ... )

Format the preamble into the given buffer. Parameters: buf  The buffer to fill with the preamble. buf_len  The length, in bytes, of 'buf'. tag  The beginning of the tag arguments. Returns: The length of preamble in the buffer. Definition at line 34 of file gkemu.c. References ensure, GKA_HostName, GKA_SystemName, gka_tag_t, and require. Referenced by sigio().

int gkFormatUpdate (  char *  buf, size_t  buf_len, gka_tag_t  tag,   ... )

Format an update into the given buffer. Parameters: buf  The buffer to fill with the preamble. buf_len  The length, in bytes, of 'buf'. tag  The beginning of the tag arguments. Returns: The length of the update in the buffer. Definition at line 109 of file gkemu.c. References ensure, GKA_CPUIdle, GKA_CPUReserveIdle, GKA_CPUReserveNice, GKA_CPUReserveUser, GKA_CPUUser, GKA_Processes, GKA_ProcessesRunning, gka_tag_t, GKA_UpTime, and require. Referenced by sigalrm().

---