Difference between revisions of "Ns schedule daily"

From AOLserver Wiki
Jump to navigation Jump to search
(imported from WiKit id 817)
 
(Corrected spelling of Daylight Saving Time)
 
(3 intermediate revisions by 3 users not shown)
Line 15: Line 15:
 
: This command schedules a ''script'' to be run at a certain ''hour'' and ''minute'' of the day.  Returns the ID of the newly scheduled script.  If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every day at that time.  If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread.  If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.
 
: This command schedules a ''script'' to be run at a certain ''hour'' and ''minute'' of the day.  Returns the ID of the newly scheduled script.  If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every day at that time.  If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread.  If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.
  
: '''NOTE:''' ''hour'' and ''minute'' are specified in local time.  Beware of Daylight Savings Time shifts affecting the time of day when the script will execute.
+
: '''NOTE:''' ''hour'' and ''minute'' are specified in local time.  Beware of Daylight Saving Time shifts affecting the time of day when the script will execute.
  
 
'''EXAMPLES'''
 
'''EXAMPLES'''
Line 26: Line 26:
 
'''SEE ALSO'''
 
'''SEE ALSO'''
  
: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_proc]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]
+
: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_schedule_proc]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]
  
 
----
 
----
  
[[Category Documentation]] - [[Category Core Tcl API]]
+
[[Category:Documentation]] - [[Category:Core Tcl API]]

Latest revision as of 14:57, 18 December 2009

Man page: http://aolserver.com/docs/tcl/ns_schedule_daily.html


NAME

ns_schedule_daily - Schedule a script to run daily at a certain time

SYNOPSIS

ns_schedule_daily ?-once? ?-thread? hour minute script

DESCRIPTION

This command schedules a script to be run at a certain hour and minute of the day. Returns the ID of the newly scheduled script. If -once is specified, then the script is run once and then unscheduled, otherwise it will continue to run every day at that time. If -thread is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.
NOTE: hour and minute are specified in local time. Beware of Daylight Saving Time shifts affecting the time of day when the script will execute.

EXAMPLES

   % set id [[ns_schedule_daily -once 5 35 { ns_log notice "It is now 5:35 AM." }]]
   123
   % ns_unschedule_proc $id

SEE ALSO

ns_after, ns_info scheduled, ns_pause, ns_schedule_proc, ns_schedule_weekly, ns_unschedule_proc

-