CrtTimerHdlr.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '"
  5. '" See the file "license.terms" for information on usage and redistribution
  6. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '" 
  8. '" RCS: @(#) $Id: CrtTimerHdlr.3,v 1.2 1998/09/14 18:39:47 stanton Exp $
  9. '" 
  10. .so man.macros
  11. .TH Tcl_CreateTimerHandler 3 7.5 Tcl "Tcl Library Procedures"
  12. .BS
  13. .SH NAME
  14. Tcl_CreateTimerHandler, Tcl_DeleteTimerHandler - call a procedure at a
  15. given time
  16. .SH SYNOPSIS
  17. .nf
  18. fB#include <tcl.h>fR
  19. .sp
  20. Tcl_TimerToken
  21. fBTcl_CreateTimerHandlerfR(fImilliseconds, proc, clientDatafR)
  22. .sp
  23. fBTcl_DeleteTimerHandlerfR(fItokenfR)
  24. .SH ARGUMENTS
  25. .AS Tcl_TimerToken milliseconds
  26. .AP int milliseconds  in
  27. How many milliseconds to wait before invoking fIprocfR.
  28. .AP Tcl_TimerProc *proc in
  29. Procedure to invoke after fImillisecondsfR have elapsed.
  30. .AP ClientData clientData in
  31. Arbitrary one-word value to pass to fIprocfR.
  32. .AP Tcl_TimerToken token in
  33. Token for previously-created timer handler (the return value
  34. from some previous call to fBTcl_CreateTimerHandlerfR).
  35. .BE
  36. .SH DESCRIPTION
  37. .PP
  38. fBTcl_CreateTimerHandlerfR arranges for fIprocfR to be
  39. invoked at a time fImillisecondsfR milliseconds in the
  40. future.
  41. The callback to fIprocfR will be made by fBTcl_DoOneEventfR,
  42. so fBTcl_CreateTimerHandlerfR is only useful in programs that
  43. dispatch events through fBTcl_DoOneEventfR or through Tcl commands
  44. such as fBvwaitfR.
  45. The call to fIprocfR may not be made at the exact time given by
  46. fImillisecondsfR:  it will be made at the next opportunity
  47. after that time.  For example, if fBTcl_DoOneEventfR isn't
  48. called until long after the time has elapsed, or if there
  49. are other pending events to process before the call to
  50. fIprocfR, then the call to fIprocfR will be delayed.
  51. .PP
  52. fIProcfR should have arguments and return value that match
  53. the type fBTcl_TimerProcfR:
  54. .CS
  55. typedef void Tcl_TimerProc(ClientData fIclientDatafR);
  56. .CE
  57. The fIclientDatafR parameter to fIprocfR is a
  58. copy of the fIclientDatafR argument given to
  59. fBTcl_CreateTimerHandlerfR when the callback
  60. was created.  Typically, fIclientDatafR points to a data
  61. structure containing application-specific information about
  62. what to do in fIprocfR.
  63. .PP
  64. fBTcl_DeleteTimerHandlerfR may be called to delete a
  65. previously-created timer handler.  It deletes the handler
  66. indicated by fItokenfR so that no call to fIprocfR
  67. will be made;  if that handler no longer exists
  68. (e.g. because the time period has already elapsed and fIprocfR
  69. has been invoked then fBTcl_DeleteTimerHandlerfR does nothing.
  70. The tokens returned by fBTcl_CreateTimerHandlerfR never have
  71. a value of NULL, so if NULL is passed to fBTcl_DeleteTimerHandlerfR
  72. then the procedure does nothing.
  73. .SH KEYWORDS
  74. callback, clock, handler, timer