JezK
Edit File: new-c.ri
U:RDoc::AnyMethod[iI"new:ETI"Concurrent::TimerTask::new;FT:publico:RDoc::Markup::Document:@parts[ o:RDoc::Markup::Paragraph; [I"BCreate a new TimerTask with the given task and configuration.;To:RDoc::Markup::BlankLine o; ; [I"+@!macro [attach] timer_task_initialize;To:RDoc::Markup::Verbatim; [I"=@param [Hash] opts the options defining task execution. ;TI"J@option opts [Integer] :execution_interval number of seconds between ;TI"5 task executions (default: EXECUTION_INTERVAL) ;TI"K@option opts [Integer] :timeout_interval number of seconds a task can ;TI"N run before it is considered to have failed (default: TIMEOUT_INTERVAL) ;TI"I@option opts [Boolean] :run_now Whether to run the task immediately ;TI"K upon instantiation or to wait until the first # execution_interval ;TI"# has passed (default: false) ;TI" ;TI"@!macro deref_options ;TI" ;TI"2@raise ArgumentError when no block is given. ;TI" ;TI"M@yield to the block after :execution_interval seconds have passed since ;TI" the last yield ;TI"J@yieldparam task a reference to the `TimerTask` instance so that the ;TI"H block can control its own lifecycle. Necessary since `self` will ;TI"K refer to the execution context of the block rather than the running ;TI" `TimerTask`. ;TI" ;TI",@return [TimerTask] the new `TimerTask`;T:@format0: @fileI"!lib/concurrent/timer_task.rb;T:0@omit_headings_from_table_of_contents_below000[ I"(opts = {}, &task);T@)TI"TimerTask;FcRDoc::NormalClass00