help | logout
next

next

Name

next -- Returns the next set of parsed history data.

Synopsis

$line = $pd->next();

Description

This function, called after the begin() routine, is designed to work with an existing connection to a history repository and gather all of the necessary data from the remote entity based on the criteria set in the RSP_parseBegin function. It is important that this function be called soon after calling begin() so that a remote server doesn't time out any network connections that may have been opened.

Each time this function is called a new "line" is returned. If no more data exists, or if there is an error, undef is returned instead. Each line of data contains a time and a piece of data as well as a graph type if graph data is being returned. These members are retrieved with getTime(), getData(), and getGraphType(). For example:

$pd->begin("plato", "CPUInfo", "idle", -1, -1, 0);

my $line;
while(defined($line = $pd->next())) {
	print $line->getTime() . " " . $line->getData() . " " . $line->getGraphType() . "\n";
}
				

The time is measured in UNIX time, that is, seconds since the Epoch (00:00:00, January 1, 1970).

Returns

The next RSP_parseLine structure retrieved from the server or undefined if all data has been retrieved or an error occurred. In case of error, the program will croak() with an appriopriate message.