Skip to content

Commit bfc2a8d

Browse files
Document delay and yield
1 parent 5fa0f0e commit bfc2a8d

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

docs/index.html

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,71 @@ <h4>Declaration</h4>
758758

759759
</div>
760760

761+
</li><li class="ddoc_member">
762+
<div class="ddoc_member_header">
763+
<div class="ddoc_header_anchor">
764+
<a href="#delay" id="delay"><code class="code">delay</code></a>
765+
</div>
766+
</div><div class="ddoc_decl">
767+
<section class="section">
768+
<div class="declaration">
769+
<h4>Declaration</h4>
770+
<div class="dlang">
771+
<p class="para">
772+
<code class="code">
773+
<span class="ddoc_anchor" id="delay"></span>void <code class="code">delay</code>(Duration <code class="code">req</code>);
774+
775+
</code>
776+
</p>
777+
</div>
778+
</div>
779+
</section>
780+
</div>
781+
<div class="ddoc_decl">
782+
<section class="section ddoc_sections">
783+
<div class="ddoc_summary">
784+
<p class="para">
785+
Suspend the current fiber or thread for <code class="code">req</code> amount of time.
786+
Note the resolution of wait is in milliseconds, a <code class="code">delay</code> of zero will still yield the execution.
787+
</p>
788+
</div>
789+
790+
</section>
791+
792+
</div>
793+
794+
</li><li class="ddoc_member">
795+
<div class="ddoc_member_header">
796+
<div class="ddoc_header_anchor">
797+
<a href="#yield" id="yield"><code class="code">yield</code></a>
798+
</div>
799+
</div><div class="ddoc_decl">
800+
<section class="section">
801+
<div class="declaration">
802+
<h4>Declaration</h4>
803+
<div class="dlang">
804+
<p class="para">
805+
<code class="code">
806+
<span class="ddoc_anchor" id="yield"></span>void <code class="code">yield</code>();
807+
808+
</code>
809+
</p>
810+
</div>
811+
</div>
812+
</section>
813+
</div>
814+
<div class="ddoc_decl">
815+
<section class="section ddoc_sections">
816+
<div class="ddoc_summary">
817+
<p class="para">
818+
Yields the execution of current fiber or thread
819+
</p>
820+
</div>
821+
822+
</section>
823+
824+
</div>
825+
761826
</li><li class="ddoc_member">
762827
<div class="ddoc_member_header">
763828
<div class="ddoc_header_anchor">

src/photon/package.d

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,16 @@ public Task goOnSameThread(void function() func) @safe;
9898
This avoids blocking event loop on computationally intensive tasks.
9999
*/
100100
T offload(T)(T delegate() work) @trusted;
101+
102+
/**
103+
Suspend the current fiber or thread for req amount of time.
104+
Note the resolution of wait is in milliseconds, a delay of zero will still yield the execution.
105+
*/
106+
public void delay(Duration req);
107+
108+
/// Yields the execution of current fiber or thread
109+
public void yield();
110+
101111
}
102112

103113
/// Number of threads running the scheduler loop

0 commit comments

Comments
 (0)