HelpSource/Classes/Condition.schelp

   1 CLASS::Condition
   2 categories::Scheduling
   3 summary::block execution of a thread
   4
   5 CLASSMETHODS::
   6
   7 method::new
   8 Create a new instance, set the strong::test:: variable.
   9
  10 INSTANCEMETHODS::
  11
  12 method::test
  13 Return the test variable (boolean).
  14
  15 method::wait
  16 Wait until the condition is true and signalled.
  17
  18 method::hang
  19 Wait for strong::value:: time, regardless of test.
  20
  21 method::signal
  22 If link::#-test:: is true, reschedule blocked threads.
  23
  24 method::unhang
  25 Resume threads.
  26
  27 EXAMPLES::
  28
  29 code::
  30 (
  31 c = Condition.new(false);
  32
  33 Routine {
  34         1.wait;
  35         "waited for 1 second".postln;
  36         1.wait;
  37         "waited for another second, now waiting for you ... ".postln;
  38         c.wait;
  39         "the condition has stopped waiting.".postln;
  40         1.wait;
  41         "waited for another second".postln;
  42         "waiting for you ... ".postln;
  43                 c.test = false;
  44                 c.wait;
  45         "the condition has stopped waiting.".postln;
  46         1.wait;
  47         "the end".postln;
  48 }.play;
  49 )
  50
  51 // continue
  52 (
  53 c.test = true;
  54 c.signal;
  55 )
  56
  57 // a typical use is a routine that can pause under certin conditions:
  58 (
  59 c = Condition.new;
  60 fork { loop { 1.wait; "going".postln; c.wait } };
  61 )
  62 c.test = true; c.signal;
  63 c.test = false;
  64 ::
  65
  66 code::
  67 // the same, using hang
  68
  69 (
  70 c = Condition.new;
  71
  72 Routine {
  73         1.wait;
  74         "waited for 1 second".postln;
  75         1.wait;
  76         "waited for another second, now waiting for you ... ".postln;
  77         c.hang;
  78         "the condition has stopped waiting.".postln;
  79         1.wait;
  80         "waited for another second".postln;
  81         "waiting for you ... ".postln;
  82         c.hang;
  83         "the condition has stopped waiting.".postln;
  84 }.play;
  85 )
  86
  87 // continue
  88 c.unhang;
  89 ::