-
Notifications
You must be signed in to change notification settings - Fork 63
/
ReceiveOnly.html
163 lines (156 loc) · 7.93 KB
/
ReceiveOnly.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<!DOCTYPE html>
<html lang="en">
<head>
<title>ReceiveOnly Class Reference</title>
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
<meta charset='utf-8'>
<script src="../../js/jquery.min.js" defer></script>
<script src="../../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/ReceiveOnly" class="dashAnchor"></a>
<a title="ReceiveOnly Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Venice Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/Zewo/Venice"><img src="../../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../../index.html">Venice Reference</a>
<img id="carat" src="../../img/carat.png" />
ReceiveOnly Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../../Handles.html">Handles</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Classes/Handle.html">Handle</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Coroutines.html">Coroutines</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Classes/Coroutine.html">Coroutine</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Coroutine/Group.html">– Group</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Channels.html">Channels</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Classes/Channel.html">Channel</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Channel/SendOnly.html">– SendOnly</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Channel/ReceiveOnly.html">– ReceiveOnly</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../File Descriptors.html">File Descriptors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Classes/FileDescriptor.html">FileDescriptor</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FileDescriptor/PollEvent.html">– PollEvent</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Time.html">Time</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Structs/Duration.html">Duration</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/Deadline.html">Deadline</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Int.html">Int</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Errors.html">Errors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Enums/VeniceError.html">VeniceError</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>ReceiveOnly</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">ReceiveOnly</span> <span class="p">:</span> <span class="kt"><a href="../../Classes/Handle.html">Handle</a></span></code></pre>
</div>
</div>
<p>Receive-only reference to an existing channel.</p>
<h2 id='example' class='heading'>Example:</h2>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">channel</span> <span class="o">=</span> <span class="kt">Channel</span><span class="o"><</span><span class="kt">Int</span><span class="o">></span><span class="p">()</span>
<span class="kd">func</span> <span class="nf">receive</span><span class="p">(</span><span class="n">from</span> <span class="nv">channel</span><span class="p">:</span> <span class="kt">Channel</span><span class="o"><</span><span class="kt">Int</span><span class="o">>.</span><span class="kt">ReceiveOnly</span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">value</span> <span class="o">=</span> <span class="k">try</span> <span class="n">channel</span><span class="o">.</span><span class="nf">receive</span><span class="p">(</span><span class="nv">deadline</span><span class="p">:</span> <span class="mi">1</span><span class="o">.</span><span class="n">second</span><span class="o">.</span><span class="nf">fromNow</span><span class="p">())</span>
<span class="p">}</span>
<span class="k">try</span> <span class="nf">receive</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="n">channel</span><span class="o">.</span><span class="n">receiveOnly</span><span class="p">)</span>
</code></pre>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FCC6Venice7Channel11ReceiveOnly7receiveFzT8deadlineVS_8Deadline_x"></a>
<a name="//apple_ref/swift/Method/receive(deadline:)" class="dashAnchor"></a>
<a class="token" href="#/s:FCC6Venice7Channel11ReceiveOnly7receiveFzT8deadlineVS_8Deadline_x">receive(deadline:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Receives a value from channel.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">@discardableResult</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">receive</span><span class="p">(</span><span class="nv">deadline</span><span class="p">:</span> <span class="kt"><a href="../../Structs/Deadline.html">Deadline</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="k">Type</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2017 <a class="link" href="http://zewo.io" target="_blank" rel="external">Zewo</a>. All rights reserved. (Last updated: 2017-05-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>