<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[3197] MacRuby/trunk/gcd.c</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.macosforge.org/projects/ruby/changeset/3197">3197</a></dd>
<dt>Author</dt> <dd>ernest.prabhakar@gmail.com</dd>
<dt>Date</dt> <dd>2010-01-06 15:35:23 -0800 (Wed, 06 Jan 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>Added rdoc for Dispatch Sources and Semaphores</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#MacRubytrunkgcdc">MacRuby/trunk/gcd.c</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="MacRubytrunkgcdc"></a>
<div class="modfile"><h4>Modified: MacRuby/trunk/gcd.c (3196 => 3197)</h4>
<pre class="diff"><span>
<span class="info">--- MacRuby/trunk/gcd.c        2010-01-06 21:20:18 UTC (rev 3196)
+++ MacRuby/trunk/gcd.c        2010-01-06 23:35:23 UTC (rev 3197)
</span><span class="lines">@@ -615,7 +615,7 @@
</span><span class="cx">  *  call-seq:
</span><span class="cx">  *    Dispatch::Group.new    =&gt;  Dispatch::Group
</span><span class="cx">  *
</span><del>- *  Returns a Queue group allowing for for aggregate synchronization.
</del><ins>+ *  Returns a Group allowing for aggregate synchronization.
</ins><span class="cx">  *  You can dispatch multiple blocks and track when they all complete, 
</span><span class="cx">  *  even though they might run on different queues. 
</span><span class="cx">  *  This behavior can be helpful when progress can’t be made until all 
</span><span class="lines">@@ -701,7 +701,6 @@
</span><span class="cx">     }
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-
</del><span class="cx"> enum SOURCE_TYPE_ENUM
</span><span class="cx"> {
</span><span class="cx">     SOURCE_TYPE_DATA_ADD,
</span><span class="lines">@@ -767,6 +766,21 @@
</span><span class="cx"> static VALUE rb_source_on_event(VALUE self, SEL sel);
</span><span class="cx"> static void rb_source_event_handler(void* sourceptr);
</span><span class="cx"> 
</span><ins>+/* 
+ *  call-seq:
+ *    Dispatch::Source.new(type, handle, mask, queue) =&gt;  Dispatch::Source
+ *
+ *  Returns a Source used to monitor a variety of system objects and events
+ *  including file descriptors, processes, virtual filesystem nodes, signal
+ *  delivery and timers.
+ *  When a state change occurs, the dispatch source will submit its event
+ *  handler block to its target queue.
+ *  
+ *     gcdq = Dispatch::Queue.new('doc')
+ *     src = Dispatch::Source.new(Dispatch::Source::DATA_ADD, 1, 2, gcdq)
+ *
+ */
+
</ins><span class="cx"> static VALUE
</span><span class="cx"> rb_source_init(VALUE self, SEL sel,
</span><span class="cx">     VALUE type, VALUE handle, VALUE mask, VALUE queue)
</span><span class="lines">@@ -788,33 +802,6 @@
</span><span class="cx">     return self;
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-static VALUE
-rb_timer_init(VALUE self, SEL sel, int argc, VALUE* argv)
-{
-    dispatch_time_t start_time;
-    rb_source_t *src = RSource(self);
-    VALUE queue = Qnil, interval = Qnil, delay = Qnil, leeway = Qnil;
-    rb_scan_args(argc, argv, &quot;31&quot;, &amp;queue, &amp;delay, &amp;interval, &amp;leeway);
-    Check_Queue(queue);
-    
-    rb_source_init(self, sel, INT2FIX(SOURCE_TYPE_TIMER),
-            INT2FIX(0), INT2FIX(0), queue);
-
-    if (NIL_P(leeway)) {
-        leeway = INT2FIX(0);
-    }
-    if (NIL_P(delay)) {
-        start_time = DISPATCH_TIME_NOW;
-    }
-    else {
-        start_time = rb_num2timeout(delay);
-    }
-
-    dispatch_source_set_timer(src-&gt;source, start_time,
-            rb_num2nsec(interval), rb_num2nsec(leeway));
-    return self;
-}
-
</del><span class="cx"> static void
</span><span class="cx"> rb_source_event_handler(void* sourceptr)
</span><span class="cx"> {
</span><span class="lines">@@ -876,7 +863,51 @@
</span><span class="cx"> 
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+
+/* 
+ *  call-seq:
+ *    Dispatch::Timer.new(delay, interval, leeway) =&gt;  Dispatch::Timer
+ *
+ *  Returns a Source that will submit the event handler block to
+ *  the target queue after delay, repeated at interval, within leeway, via
+ *  a call to dispatch_source_set_timer(3).
+ *  A best effort attempt is made to submit the event handler block to the
+ *  target queue at the specified time; however, actual invocation may occur at
+ *  a later time even if the leeway is zero.
+ *  
+ *     gcdq = Dispatch::Queue.new('doc')
+ *     timer = Dispatch::Timer.new(Time.now, 5, 0.1)
+ *
+ */
+
</ins><span class="cx"> static VALUE
</span><ins>+rb_timer_init(VALUE self, SEL sel, int argc, VALUE* argv)
+{
+    dispatch_time_t start_time;
+    rb_source_t *src = RSource(self);
+    VALUE queue = Qnil, interval = Qnil, delay = Qnil, leeway = Qnil;
+    rb_scan_args(argc, argv, &quot;31&quot;, &amp;queue, &amp;delay, &amp;interval, &amp;leeway);
+    Check_Queue(queue);
+    
+    rb_source_init(self, sel, INT2FIX(SOURCE_TYPE_TIMER),
+            INT2FIX(0), INT2FIX(0), queue);
+
+    if (NIL_P(leeway)) {
+        leeway = INT2FIX(0);
+    }
+    if (NIL_P(delay)) {
+        start_time = DISPATCH_TIME_NOW;
+    }
+    else {
+        start_time = rb_num2timeout(delay);
+    }
+
+    dispatch_source_set_timer(src-&gt;source, start_time,
+            rb_num2nsec(interval), rb_num2nsec(leeway));
+    return self;
+}
+
+static VALUE
</ins><span class="cx"> rb_semaphore_alloc(VALUE klass, SEL sel)
</span><span class="cx"> {
</span><span class="cx">     NEWOBJ(s, rb_semaphore_t);
</span><span class="lines">@@ -886,6 +917,29 @@
</span><span class="cx">     return (VALUE)s;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+
+/* 
+ *  call-seq:
+ *    Dispatch::Semaphore.new(count) =&gt;  Dispatch::Semaphore
+ *
+ *  Returns a Semaphore used to synchronize threads through a combination of
+ *  waiting and signalling
+ *
+ *  If the count parameter is equal to zero, the semaphore is useful for
+ *  synchronizing completion of work:
+ *
+ *     gcdq = Dispatch::Queue.new('doc')
+ *     sema = Dispatch::Semaphore.new(0)
+ *     gcdq.async { puts &quot;Begin.&quot;; sema.signal }
+ *     puts &quot;Waiting...&quot;
+ *     sema.wait
+ *     puts &quot;End!&quot;
+ *
+ *  If the count parameter is greater than zero, then the semaphore is useful
+ *  for managing a finite pool of resources.
+ *
+ */
+
</ins><span class="cx"> static VALUE
</span><span class="cx"> rb_semaphore_init(VALUE self, SEL sel, VALUE value)
</span><span class="cx"> {
</span><span class="lines">@@ -899,22 +953,53 @@
</span><span class="cx">     return self;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+/* 
+ *  call-seq:
+ *    sema.signal =&gt; true or false
+ *
+ *  Signals the semaphore to wake up any waiting threads
+ *
+ *  Returns true if no thread is waiting, false otherwise
+ *
+ *     gcdq = Dispatch::Queue.new('doc')
+ *     sema = Dispatch::Semaphore.new(0)
+ *     gcdq.async { sleep 0.1; sema.signal } #=&gt; false
+ *     sema.wait
+ *
+ */
</ins><span class="cx"> static VALUE
</span><del>-rb_semaphore_wait(VALUE self, SEL sel, int argc, VALUE *argv)
</del><ins>+rb_semaphore_signal(VALUE self, SEL sel)
</ins><span class="cx"> {
</span><del>-    VALUE num;
-    rb_scan_args(argc, argv, &quot;01&quot;, &amp;num);
-    return dispatch_semaphore_wait(RSemaphore(self)-&gt;sem, rb_num2timeout(num))
</del><ins>+    return dispatch_semaphore_signal(RSemaphore(self)-&gt;sem)
</ins><span class="cx">      == 0        ? Qtrue : Qfalse;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+/* 
+ *  call-seq:
+ *    sema.wait(timeout) =&gt; true or false
+ *
+ *  Waits (blocks the thread) until a signal arrives or the timeout expires.
+ *  Timeout defaults to DISPATCH_TIME_FOREVER.
+ *
+ *  Returns true if signalled, false if timed out.
+ *
+ *     gcdq = Dispatch::Queue.new('doc')
+ *     sema = Dispatch::Semaphore.new(0)
+ *     gcdq.async { sleep 0.1; sema.signal }
+ *     sema.wait #=&gt; true
+ *
+ */
+
</ins><span class="cx"> static VALUE
</span><del>-rb_semaphore_signal(VALUE self, SEL sel)
</del><ins>+rb_semaphore_wait(VALUE self, SEL sel, int argc, VALUE *argv)
</ins><span class="cx"> {
</span><del>-    return dispatch_semaphore_signal(RSemaphore(self)-&gt;sem)
</del><ins>+    VALUE num;
+    rb_scan_args(argc, argv, &quot;01&quot;, &amp;num);
+    return dispatch_semaphore_wait(RSemaphore(self)-&gt;sem, rb_num2timeout(num))
</ins><span class="cx">      == 0        ? Qtrue : Qfalse;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> static IMP rb_semaphore_finalize_super;
</span><span class="cx"> 
</span><span class="cx"> static void
</span></span></pre>
</div>
</div>

</body>
</html>