diff options
Diffstat (limited to 'doc/GetTime.3')
| -rw-r--r-- | doc/GetTime.3 | 71 |
1 files changed, 31 insertions, 40 deletions
diff --git a/doc/GetTime.3 b/doc/GetTime.3 index f4da364..14a9e8c 100644 --- a/doc/GetTime.3 +++ b/doc/GetTime.3 @@ -19,21 +19,27 @@ Tcl_GetTime, Tcl_SetTimeProc, Tcl_QueryTimeProc \- get date and time .sp \fBTcl_QueryTimeProc\fR(\fIgetProcPtr, scaleProcPtr, clientDataPtr\fR) .SH ARGUMENTS -.AS Tcl_GetTimeProc *getProc in -.AP Tcl_Time *timePtr out +.AS "Tcl_Time *" timePtr out +.AP "Tcl_Time *" timePtr out Points to memory in which to store the date and time information. -.AP Tcl_GetTimeProc getProc in +.AS "Tcl_GetTimeProc *" getProc in +.AP "Tcl_GetTimeProc *" getProc in Pointer to handler function replacing \fBTcl_GetTime\fR's access to the OS. -.AP Tcl_ScaleTimeProc scaleProc in +.AS "Tcl_ScaleTimeProc *" scaleProc in +.AP "Tcl_ScaleTimeProc *" scaleProc in Pointer to handler function for the conversion of time delays in the virtual domain to real-time. -.AP ClientData clientData in +.AS "ClientData *" clientData in +.AP "ClientData *" clientData in Value passed through to the two handler functions. -.AP Tcl_GetTimeProc *getProcPtr out +.AS "Tcl_GetTimeProc **" getProcPtr inout +.AP "Tcl_GetTimeProc **" getProcPtr inout Pointer to place the currently registered get handler function into. -.AP Tcl_ScaleTimeProc *scaleProcPtr out +.AS "Tcl_ScaleTimeProc **" scaleProcPtr inout +.AP "Tcl_ScaleTimeProc **" scaleProcPtr inout Pointer to place the currently registered scale handler function into. -.AP ClientData *clientDataPtr out +.AS "ClientData **" clientDataPtr inout +.AP "ClientData **" clientDataPtr inout Pointer to place the currently registered pass-through value into. .BE .SH DESCRIPTION @@ -41,12 +47,11 @@ Pointer to place the currently registered pass-through value into. The \fBTcl_GetTime\fR function retrieves the current time as a \fITcl_Time\fR structure in memory the caller provides. This structure has the following definition: -.PP .CS typedef struct Tcl_Time { - long \fIsec\fR; - long \fIusec\fR; -} \fBTcl_Time\fR; + long sec; + long usec; +} Tcl_Time; .CE .PP On return, the \fIsec\fR member of the structure is filled in with the @@ -63,47 +68,33 @@ computer system. On multiprocessor variants of Windows, this number may be limited to the 10- or 20-ms granularity of the system clock. (On single-processor Windows systems, the \fIusec\fR field is derived from a performance counter and is highly precise.) -.SS "VIRTUALIZED TIME" .PP -The \fBTcl_SetTimeProc\fR function registers two related handler functions +The \fBTcl_SetTime\fR function registers two related handler functions with the core. The first handler function is a replacement for \fBTcl_GetTime\fR, or rather the OS access made by \fBTcl_GetTime\fR. The other handler function is used by the Tcl notifier to convert wait/block times from the virtual domain into real time. .PP -The \fBTcl_QueryTimeProc\fR function returns the currently registered +The \fBTcl_QueryTime\fR function returns the currently registered handler functions. If no external handlers were set then this will return the standard handlers accessing and processing the native time of the OS. The arguments to the function are allowed to be NULL; and any argument which is NULL is ignored and not set. .PP -The signatures of the handler functions are as follows: -.PP -.CS -typedef void \fBTcl_GetTimeProc\fR( - Tcl_Time *\fItimebuf\fR, - ClientData \fIclientData\fR); -typedef void \fBTcl_ScaleTimeProc\fR( - Tcl_Time *\fItimebuf\fR, - ClientData \fIclientData\fR); -.CE -.PP -The \fItimebuf\fR fields contain the time to manipulate, and the -\fIclientData\fR fields contain a pointer supplied at the time the handler -functions were registered. -.PP -Any handler pair specified has to return data which is consistent between -them. In other words, setting one handler of the pair to something assuming a -10-times slowdown, and the other handler of the pair to something assuming a -two-times slowdown is wrong and not allowed. +Any handler pair specified has to return data which is consistent +between them. In other words, setting one handler of the pair to +something assuming a 10-times slowdown, and the other handler of the +pair to something assuming a two-times slowdown is wrong and not +allowed. .PP -The set handler functions are allowed to run the delivered time backwards, -however this should be avoided. We have to allow it as the native time can run -backwards as the user can fiddle with the system time one way or other. Note -that the insertion of the hooks will not change the behavior of the Tcl core -with regard to this situation, i.e. the existing behavior is retained. +The set handler functions are allowed to run the delivered time +backwards, however this should be avoided. We have to allow it as the +native time can run backwards as the user can fiddle with the system +time one way or other. Note that the insertion of the hooks will not +change the behaviour of the Tcl core with regard to this situation, +i.e. the existing behaviour is retained. .SH "SEE ALSO" -clock(n) +clock .SH KEYWORDS date, time |