pmparseinterval(3) [centos man page]

PMPARSEINTERVAL(3)					     Library Functions Manual						PMPARSEINTERVAL(3)

NAME

       pmParseInterval - convert interval string to timeval structure

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmParseInterval(const char *string, struct timeval *rslt, char **errmsg);

       cc ... -lpcp

DESCRIPTION

       pmParseInterval parses the argument string specifying an interval of time and fills in the tv_sec and tv_usec components of the rslt struc-
       ture to represent that interval.

       The input string is most commonly the argument following a -t command line option to a PCP application, and the syntax is  fully  described
       in PCPIntro(1).

       pmParseInterval returns 0 and errmsg is undefined if the parsing is successful.

       If  the given string does not conform to the required syntax pmParseInterval returns -1 and a dynamically allocated error message string in
       errmsg.	The error message is terminated with a newline and includes the text of the input string along with an indicator of  the  position
       at which the error was detected, e.g.
		 4minutes 30mumble
			    ^ -- unexpected value

       In the case of an error, the caller is responsible for calling free(3C) to release the space allocated for errmsg.

SEE ALSO

       PMAPI(3) and pmParseTimeWindow(3).

Performance Co-Pilot							PCP							PMPARSEINTERVAL(3)

PMPARSETIME(3)						     Library Functions Manual						    PMPARSETIME(3)

NAME

       __pmParseTime - parse time point specification

C SYNOPSIS

       #include <pcp/pmapi.h>
       #include <pcp/impl.h>

       int __pmParseTime(const char *string, struct timeval *logStart, struct timeval *logEnd, struct timeval *rslt, char **errMsg);

       cc ... -lpcp

DESCRIPTION

       __pmParseTime  is  designed  to	encapsulate  the  interpretation of a time point specification in command line switches for use by the PCP
       client tools.

       This function expects to be called with the time point specification as string.	If the tool is running against PCP  archive(s),  you  also
       need to supply the start time of the first (only) archive as logStart, and the end of the last (only) archive as logEnd.  See pmGetArchive-
       Label(3) and pmGetArchiveEnd(3) for how to obtain values for these parameters.  If the tool is running against a live feed  of  performance
       data, logStart should be the current time (but could be aligned on the next second for example), while logEnd should have its tv_sec compo-
       nent set to INT_MAX.

       The rslt structure must be allocated before calling __pmParseTime.

       You also need to set the current PCP reporting time zone to correctly reflect the -z and -Z command line parameters  before  calling  __pm-
       ParseTime.  See pmUseZone(3) and friends for information on how this is done.

       If  the	conversion  is successful, __pmParseTime returns 0, and fills in rslt with the time value defined by the input parameters.  If the
       argument strings could not be parsed, it returns -1 and a dynamically allocated error message string in errMsg.	Be sure to  free(3C)  this
       error message string.

SEE ALSO

       PMAPI(3),  pmGetArchiveEnd(3),  pmGetArchiveLabel(3),  pmNewContextZone(3),  pmNewZone(3), pmParseInterval(3), pmParseTimeWindow(3), pmUse-
       Zone(3), __pmConvertTime(3) and __pmParseCtime(3).

Performance Co-Pilot							PCP							    PMPARSETIME(3)