/
wrapper.rb
239 lines (189 loc) · 5.26 KB
/
wrapper.rb
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# frozen_string_literal: true
# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
require 'nio'
module Async
# Represents an asynchronous IO within a reactor.
class Wrapper
class Cancelled < StandardError
class From
def initialize
@backtrace = caller[5..-1]
end
attr :backtrace
def cause
nil
end
def message
"Cancelled"
end
end
def initialize
super "The operation has been cancelled!"
@cause = From.new
end
attr :cause
end
# wait_readable, wait_writable and wait_any are not re-entrant, and will raise this failure.
class WaitError < StandardError
def initialize
super "A fiber is already waiting!"
end
end
# @param io the native object to wrap.
# @param reactor [Reactor] the reactor that is managing this wrapper, or not specified, it's looked up by way of {Task.current}.
def initialize(io, reactor = nil)
@io = io
@reactor = reactor
@monitor = nil
@readable = nil
@writable = nil
@any = nil
end
def dup
self.class.new(@io.dup, @reactor)
end
def resume(*arguments)
# It's possible that the monitor was closed before calling resume.
return unless @monitor
readiness = @monitor.readiness
if @readable and (readiness == :r or readiness == :rw)
@readable.resume(*arguments)
end
if @writable and (readiness == :w or readiness == :rw)
@writable.resume(*arguments)
end
if @any
@any.resume(*arguments)
end
end
# The underlying native `io`.
attr :io
# The reactor this wrapper is associated with, if any.
attr :reactor
# The monitor for this wrapper, if any.
attr :monitor
# Bind this wrapper to a different reactor. Assign nil to convert to an unbound wrapper (can be used from any reactor/task but with slightly increased overhead.)
# Binding to a reactor is purely a performance consideration. Generally, I don't like APIs that exist only due to optimisations. This is borderline, so consider this functionality semi-private.
def reactor= reactor
return if @reactor.equal?(reactor)
cancel_monitor
@reactor = reactor
end
# Wait for the io to become readable.
def wait_readable(timeout = nil)
raise WaitError if @readable
self.reactor = Task.current.reactor
begin
@readable = Fiber.current
wait_for(timeout)
ensure
@readable = nil
@monitor.interests = interests if @monitor
end
end
# Wait for the io to become writable.
def wait_writable(timeout = nil)
raise WaitError if @writable
self.reactor = Task.current.reactor
begin
@writable = Fiber.current
wait_for(timeout)
ensure
@writable = nil
@monitor.interests = interests if @monitor
end
end
# Wait fo the io to become either readable or writable.
# @param duration [Float] timeout after the given duration if not `nil`.
def wait_any(timeout = nil)
raise WaitError if @any
self.reactor = Task.current.reactor
begin
@any = Fiber.current
wait_for(timeout)
ensure
@any = nil
@monitor.interests = interests if @monitor
end
end
# Close the io and monitor.
def close
cancel_monitor
@io.close
end
def closed?
@io.closed?
end
private
# What an abomination.
def interests
if @any
return :rw
elsif @readable
if @writable
return :rw
else
return :r
end
elsif @writable
return :w
end
return nil
end
def cancel_monitor
if @readable
readable = @readable
@readable = nil
readable.resume(Cancelled.new)
end
if @writable
writable = @writable
@writable = nil
writable.resume(Cancelled.new)
end
if @any
any = @any
@any = nil
any.resume(Cancelled.new)
end
if @monitor
@monitor.close
@monitor = nil
end
end
def wait_for(timeout)
if @monitor
@monitor.interests = interests
else
@monitor = @reactor.register(@io, interests, self)
end
# If the user requested an explicit timeout for this operation:
if timeout
@reactor.with_timeout(timeout) do
Task.yield
end
else
Task.yield
end
return true
end
end
end