RSP_parseBegin

Name

RSP_parseBegin -- Prepares to parse history data.

Synopsis

int RSP_parseBegin(RSP_parseData *pd, char* szHost, char* szModule, char* szKey, time_t beginTime, time_t endTime, int bDataString);

Description

Once the RSP_parseData structure has been setup properly, this function will attempt to connect to either a History Listener or a MySQL database server as specified by RSP_newParseRemote or RSP_newParseMySQL. Use the RSP_parseNext routine to retrieve appropriate history data.

This function must be given a specific host and module whose data you want to retrieve. The bDataString parameter is a boolean, 0 or 1. Giving 0 says that you want to retrieve graph data from the server. In this case you must also set the key you want with szKey. If bDataString is set to 1, the string data on the server is returned and szKey is ignored (you may set it to NULL in this case). This string data is the values you see in RSP Web and JRSP, such as "Used = 90%, Idle = 10%" for CPUInfo. Note that by default RSPD does not save this data as it can take up large amounts of space. Use the "history" variable in RSPD configuration to change this. (Please refer to Chapter 2 for more information on this).

In addition, you may set a time frame for the data you wish to recieve. Use beginTime or endTime for this. These parameters must be set as UNIX time, that is, seconds since the Epoch (00:00:00, January 1, 1970). Either or both may be set to -1 for them to be ignored.

Returns

This function returns 0 if no error occurred, and -1 otherwise.

Error Conditions

This function will return 0 if no error occurred, and -1 otherwise (with rsp_error set appropriately). The rsp_error variable may be set to any of the following error codes: