HelpSource/Classes/Thread.schelp

   1 class::Thread
   2 summary::represents an individual operating system thread
   3 categories::Core>Kernel
   4 related:: Classes/Routine
   5
   6 description::
   7
   8 Normally there is no need to instantiate a Thread, but its subclass Routine is very useful.
   9
  10 It is wise not to fiddle with the source code for this class; see the warnings in the class file.
  11
  12 method:: thisThread
  13 The global pseudo-variable code::thisThread:: always returns the enclosing thread running the given code. A Thread is aware of its own attached clock and associated beats and seconds timing, and has an individual random number seed and exception handler.
  14
  15 classMethods::
  16
  17 method::new
  18
  19 Create a Thread.
  20
  21 discussion:: You will not typically do this yourself but as a result of creating Routines, for example.
  22
  23 code::
  24 g = Thread({"hello".postln;});
  25 g.seconds; //time of creation, cannot advance without a clock
  26 ::
  27
  28 argument::func
  29 A function with code for the thread to run.
  30
  31 argument::stackSize
  32 defaults to 64 depth call stack.
  33
  34 instanceMethods::
  35
  36 method::beats
  37 Get or set the elapsed beats (logical time) of the thread
  38
  39 method::seconds
  40 Get or set the elapsed seconds (logical time) of the thread.
  41
  42 method::clock
  43 Get or set the thread's clock
  44
  45 method::isPlaying
  46 Returns:: true if it is playing
  47
  48 code::
  49 // example
  50 thisThread.beats;
  51 thisThread.seconds;
  52 thisThread.clock;
  53 ::
  54
  55 method::state
  56
  57 The internal state values for a Thread instance can be polled:
  58 table::
  59 ## 0 || not started
  60 ## 7 || running
  61 ## 8 || stopped
  62 ::
  63
  64 subsection::Seeding the random number generator
  65
  66 see also: link::Reference/randomSeed::
  67
  68 method::randSeed
  69 Set the random number generator seed using a single integer
  70 discussion::
  71 Example:
  72 code::
  73 g = thisThread.randSeed = 4;
  74 10.do{1.0.rand2.postln};
  75 ::
  76
  77 method::randData
  78
  79 Get or set the three integer array which defines the internal basis for the random number generator.  You can use this to get back the exact same random number sequence, and it provides a mechanism for automatic replay for generative music.
  80 discussion::
  81 Example:
  82 code::
  83 g = thisThread.randData;
  84 10.do{1.0.rand2.postln};
  85 ::
  86 code::
  87 // each time the seed is reset, the random number generation should give the same sequence
  88 thisThread.randData_(Int32Array[ -662787342, 1546785953, 1661466823 ]);
  89 10.do{1.0.rand2.postln};
  90 ::
  91