Class: Libuv::Reactor
- Extended by:
- Accessors, ClassMethods
- Includes:
- Assertions, Resource
- Defined in:
- lib/libuv/reactor.rb
Defined Under Namespace
Modules: ClassMethods
Constant Summary collapse
- CRITICAL =
::Mutex.new
Constants included from Accessors
Constants included from Assertions
Instance Attribute Summary collapse
-
#fiber_pool ⇒ Object
readonly
Returns the value of attribute fiber_pool.
-
#run_count ⇒ Object
readonly
Returns the value of attribute run_count.
Instance Method Summary collapse
-
#active_handles ⇒ Object
Return the number of active handles in the event loop.
-
#all(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when all of the input promises are resolved.
-
#any(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when any of the input promises are resolved.
-
#async(callback = nil, &block) ⇒ ::Libuv::Async
Get a new Async handle.
-
#check(callback = nil, &blk) ⇒ ::Libuv::Check
Get a new Check handle.
-
#defer ⇒ ::Libuv::Q::Deferred
Creates a deferred result object for where the result of an operation may only be returned at some point in the future or is being processed on a different thread (thread safe).
-
#exec ⇒ Object
Execute the provided block of code in a fiber from the pool.
-
#file(path, flags = 0, mode: 0, **opts, &blk) ⇒ ::Libuv::File
Opens a file and returns an object that can be used to manipulate it.
-
#filesystem ⇒ ::Libuv::Filesystem
Returns an object for manipulating the filesystem.
-
#finally(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when all of the input promises are resolved or rejected.
-
#fs_event(path) ⇒ ::Libuv::FSEvent
Get a new FSEvent instance.
- #handle ⇒ Object
-
#idle(callback = nil, &block) ⇒ ::Libuv::Idle
Get a new Idle handle.
-
#initialize(pointer) ⇒ Reactor
constructor
Initialize a reactor using an FFI::Pointer to a libuv reactor.
-
#inspect ⇒ Object
Overwrite as errors in jRuby can literally hang VM when inspecting as many many classes will reference this class.
-
#log(error, msg = nil, trace = nil) ⇒ Object
Notifies the reactor there was an event that should be logged.
-
#lookup(hostname, hint = :IPv4, port = 9, wait: true, &block) ⇒ ::Libuv::Dns
Lookup a hostname.
-
#lookup_error(err) ⇒ ::Libuv::Error
Lookup an error code and return is as an error object.
-
#next_tick(&block) ⇒ Object
Queue some work to be processed in the next iteration of the event reactor (thread safe).
-
#notifier(callback = nil, &blk) ⇒ ::Libuv::Q::Promise
Provides a promise notifier for receiving un-handled exceptions.
-
#now ⇒ Integer
Get current time in milliseconds.
-
#on_program_interrupt(callback = nil, &block) ⇒ Object
Allows user defined behaviour when sig int is received.
-
#pipe(ipc = false) ⇒ ::Libuv::Pipe
Get a new Pipe instance.
-
#prepare(callback = nil, &blk) ⇒ ::Libuv::Prepare
Get a new Prepare handle.
-
#reactor_running? ⇒ Boolean
(also: #running?)
Tells you whether the Libuv reactor reactor is currently running.
-
#reactor_thread? ⇒ Boolean
True if the calling thread is the same thread as the reactor.
-
#ref ⇒ Object
Prevents the reactor loop from stopping.
-
#reject(reason) ⇒ Object
Creates a promise that is resolved as rejected with the specified reason.
-
#run(run_type = :UV_RUN_DEFAULT) {|promise| ... } ⇒ Object
Run the actual event reactor.
-
#schedule { ... } ⇒ Object
Schedule some work to be processed on the event reactor as soon as possible (thread safe).
-
#signal(signum = nil, callback = nil, &block) ⇒ ::Libuv::Signal
Get a new signal handler.
- #sleep(msecs) ⇒ Object
- #spawn(cmd, **args) ⇒ Object
-
#stop ⇒ Object
Closes handles opened by the reactor class and completes the current reactor iteration (thread safe).
-
#tcp(callback = nil, **opts, &blk) ⇒ ::Libuv::TCP
Get a new TCP instance.
-
#timer(callback = nil, &blk) ⇒ ::Libuv::Timer
Get a new timer instance.
-
#tty(fileno, readable = false) ⇒ ::Libuv::TTY
Get a new TTY instance.
-
#udp(callback = nil, **opts, &blk) ⇒ ::Libuv::UDP
Get a new UDP instance.
-
#unref ⇒ Object
Allows the reactor loop to stop.
-
#update_time ⇒ Object
forces reactor time update, useful for getting more granular times.
-
#work(callback = nil, &block) ⇒ ::Libuv::Work
Queue some work for processing in the libuv thread pool.
Methods included from Accessors
Methods included from ClassMethods
Methods included from Resource
#check_result, #check_result!, #resolve, #to_ptr
Methods included from Assertions
#assert_block, #assert_boolean, #assert_type
Constructor Details
#initialize(pointer) ⇒ Reactor
Initialize a reactor using an FFI::Pointer to a libuv reactor
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 |
# File 'lib/libuv/reactor.rb', line 56 def initialize(pointer) # :notnew: @pointer = pointer @reactor = self @run_count = 0 @ref_count = 0 @fiber_pool = FiberPool.new(self) # Create an async call for scheduling work from other threads @run_queue = Queue.new @process_queue = @reactor.async method(:process_queue_cb) @process_queue.unref # Create a next tick timer @next_tick = @reactor.timer method(:next_tick_cb) @next_tick.unref # Create an async call for ending the reactor @stop_reactor = @reactor.async method(:stop_cb) @stop_reactor.unref # Libuv can prevent the application shutting down once the main thread has ended # The addition of a prepare function prevents this from happening. @reactor_prep = Libuv::Prepare.new(@reactor, method(:noop)) @reactor_prep.unref @reactor_prep.start # LibUV ingnores program interrupt by default. # We provide normal behaviour and allow this to be overriden @on_signal = [] sig_callback = method(:signal_cb) self.signal(:INT, sig_callback).unref self.signal(:HUP, sig_callback).unref self.signal(:TERM, sig_callback).unref # Notify of errors @throw_on_exit = nil @reactor_notify_default = @reactor_notify = proc { |error| @throw_on_exit = error } @fiber_pool.on_error &@reactor_notify end |
Instance Attribute Details
#fiber_pool ⇒ Object (readonly)
Returns the value of attribute fiber_pool.
98 99 100 |
# File 'lib/libuv/reactor.rb', line 98 def fiber_pool @fiber_pool end |
#run_count ⇒ Object (readonly)
Returns the value of attribute run_count.
98 99 100 |
# File 'lib/libuv/reactor.rb', line 98 def run_count @run_count end |
Instance Method Details
#active_handles ⇒ Object
Return the number of active handles in the event loop
220 221 222 223 |
# File 'lib/libuv/reactor.rb', line 220 def active_handles uvloop = Ext::UvLoop.new @pointer uvloop[:active_handles] end |
#all(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when all of the input promises are resolved. (thread safe)
250 251 252 |
# File 'lib/libuv/reactor.rb', line 250 def all(*promises) Q.all(@reactor, *promises) end |
#any(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when any of the input promises are resolved.
260 261 262 |
# File 'lib/libuv/reactor.rb', line 260 def any(*promises) Q.any(@reactor, *promises) end |
#async(callback = nil, &block) ⇒ ::Libuv::Async
Get a new Async handle
391 392 393 394 395 396 |
# File 'lib/libuv/reactor.rb', line 391 def async(callback = nil, &block) callback ||= block handle = Async.new(@reactor) handle.progress callback if callback handle end |
#check(callback = nil, &blk) ⇒ ::Libuv::Check
Get a new Check handle
376 377 378 |
# File 'lib/libuv/reactor.rb', line 376 def check(callback = nil, &blk) Check.new(@reactor, callback || blk) end |
#defer ⇒ ::Libuv::Q::Deferred
Creates a deferred result object for where the result of an operation may only be returned at some point in the future or is being processed on a different thread (thread safe)
238 239 240 |
# File 'lib/libuv/reactor.rb', line 238 def defer Q.defer(@reactor) end |
#exec ⇒ Object
Execute the provided block of code in a fiber from the pool
199 200 201 |
# File 'lib/libuv/reactor.rb', line 199 def exec @fiber_pool.exec { yield } end |
#file(path, flags = 0, mode: 0, **opts, &blk) ⇒ ::Libuv::File
Opens a file and returns an object that can be used to manipulate it
458 459 460 461 462 463 |
# File 'lib/libuv/reactor.rb', line 458 def file(path, flags = 0, mode: 0, **opts, &blk) assert_type(String, path, "path must be a String") assert_type(Integer, flags, "flags must be an Integer") assert_type(Integer, mode, "mode must be an Integer") File.new(@reactor, path, flags, mode: mode, **opts, &blk) end |
#filesystem ⇒ ::Libuv::Filesystem
Returns an object for manipulating the filesystem
468 469 470 |
# File 'lib/libuv/reactor.rb', line 468 def filesystem Filesystem.new(@reactor) end |
#finally(*promises) ⇒ ::Libuv::Q::Promise
Combines multiple promises into a single promise that is resolved when all of the input promises are resolved or rejected.
271 272 273 |
# File 'lib/libuv/reactor.rb', line 271 def finally(*promises) Q.finally(@reactor, *promises) end |
#fs_event(path) ⇒ ::Libuv::FSEvent
Get a new FSEvent instance
447 448 449 450 |
# File 'lib/libuv/reactor.rb', line 447 def fs_event(path) assert_type(String, path) FSEvent.new(@reactor, path) end |
#handle ⇒ Object
157 |
# File 'lib/libuv/reactor.rb', line 157 def handle; @pointer; end |
#idle(callback = nil, &block) ⇒ ::Libuv::Idle
Get a new Idle handle
384 385 386 |
# File 'lib/libuv/reactor.rb', line 384 def idle(callback = nil, &block) Idle.new(@reactor, callback || block) end |
#inspect ⇒ Object
Overwrite as errors in jRuby can literally hang VM when inspecting as many many classes will reference this class
152 153 154 |
# File 'lib/libuv/reactor.rb', line 152 def inspect "#<#{self.class}:0x#{self.__id__.to_s(16)} NT=#{@run_queue.length}>" end |
#log(error, msg = nil, trace = nil) ⇒ Object
Notifies the reactor there was an event that should be logged
513 514 515 |
# File 'lib/libuv/reactor.rb', line 513 def log(error, msg = nil, trace = nil) @reactor_notify.call(error, msg, trace) end |
#lookup(hostname, hint = :IPv4, port = 9, wait: true, &block) ⇒ ::Libuv::Dns
Lookup a hostname
432 433 434 435 436 437 438 439 440 |
# File 'lib/libuv/reactor.rb', line 432 def lookup(hostname, hint = :IPv4, port = 9, wait: true, &block) dns = Dns.new(@reactor, hostname, port, hint, wait: wait) # Work is a promise object if block_given? || !wait dns.then block dns else dns.results end end |
#lookup_error(err) ⇒ ::Libuv::Error
Lookup an error code and return is as an error object
301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/libuv/reactor.rb', line 301 def lookup_error(err) name = ::Libuv::Ext.err_name(err) if name msg = ::Libuv::Ext.strerror(err) ::Libuv::Error.const_get(name.to_sym).new("#{msg}, #{name}:#{err}") else # We want a back-trace in this case raise "error lookup failed for code #{err}" end rescue Exception => e @reactor.log e, 'performing error lookup' e end |
#next_tick(&block) ⇒ Object
Queue some work to be processed in the next iteration of the event reactor (thread safe)
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 |
# File 'lib/libuv/reactor.rb', line 492 def next_tick(&block) @run_queue << block if reactor_thread? # Create a next tick timer if not @next_tick_scheduled @next_tick.start(0) @next_tick_scheduled = true @next_tick.ref end else @process_queue.call end self end |
#notifier(callback = nil, &blk) ⇒ ::Libuv::Q::Promise
Provides a promise notifier for receiving un-handled exceptions
229 230 231 232 |
# File 'lib/libuv/reactor.rb', line 229 def notifier(callback = nil, &blk) @reactor_notify = callback || blk || @reactor_notify_default self end |
#now ⇒ Integer
Get current time in milliseconds
293 294 295 |
# File 'lib/libuv/reactor.rb', line 293 def now ::Libuv::Ext.now(@pointer) end |
#on_program_interrupt(callback = nil, &block) ⇒ Object
Allows user defined behaviour when sig int is received
410 411 412 413 |
# File 'lib/libuv/reactor.rb', line 410 def on_program_interrupt(callback = nil, &block) @on_signal << (callback || block) self end |
#pipe(ipc = false) ⇒ ::Libuv::Pipe
Get a new Pipe instance
354 355 356 |
# File 'lib/libuv/reactor.rb', line 354 def pipe(ipc = false) Pipe.new(@reactor, ipc) end |
#prepare(callback = nil, &blk) ⇒ ::Libuv::Prepare
Get a new Prepare handle
369 370 371 |
# File 'lib/libuv/reactor.rb', line 369 def prepare(callback = nil, &blk) Prepare.new(@reactor, callback || blk) end |
#reactor_running? ⇒ Boolean Also known as: running?
Tells you whether the Libuv reactor reactor is currently running.
532 533 534 |
# File 'lib/libuv/reactor.rb', line 532 def reactor_running? @reactor_running end |
#reactor_thread? ⇒ Boolean
True if the calling thread is the same thread as the reactor.
525 526 527 |
# File 'lib/libuv/reactor.rb', line 525 def reactor_thread? self == Thread.current.thread_variable_get(:reactor) end |
#ref ⇒ Object
Prevents the reactor loop from stopping
204 205 206 207 208 209 |
# File 'lib/libuv/reactor.rb', line 204 def ref if reactor_thread? && reactor_running? @process_queue.ref if @ref_count == 0 @ref_count += 1 end end |
#reject(reason) ⇒ Object
Creates a promise that is resolved as rejected with the specified reason. This api should be used to forward rejection in a chain of promises. If you are dealing with the last promise in a promise chain, you don’t need to worry about it.
278 279 280 |
# File 'lib/libuv/reactor.rb', line 278 def reject(reason) Q.reject(@reactor, reason) end |
#run(run_type = :UV_RUN_DEFAULT) {|promise| ... } ⇒ Object
Run the actual event reactor. This method will block until the reactor is stopped.
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 |
# File 'lib/libuv/reactor.rb', line 164 def run(run_type = :UV_RUN_DEFAULT) if not @reactor_running begin @reactor_running = true raise 'only one reactor allowed per-thread' if Thread.current.thread_variable_get(:reactor) Thread.current.thread_variable_set(:reactor, @reactor) @throw_on_exit = nil update_time @fiber_pool.reset @fiber_pool.exec { yield @reactor } if block_given? @run_count += 1 ::Libuv::Ext.run(@pointer, run_type) # This is blocking ensure Thread.current.thread_variable_set(:reactor, nil) @reactor_running = false @run_queue.clear end # Raise the last unhandled error to occur on the reactor thread raise @throw_on_exit if @throw_on_exit elsif block_given? if reactor_thread? update_time yield @reactor else raise 'reactor already running on another thread' end end @reactor end |
#schedule { ... } ⇒ Object
Schedule some work to be processed on the event reactor as soon as possible (thread safe)
479 480 481 482 483 484 485 486 487 |
# File 'lib/libuv/reactor.rb', line 479 def schedule if reactor_thread? yield else @run_queue << Proc.new @process_queue.call end self end |
#signal(signum = nil, callback = nil, &block) ⇒ ::Libuv::Signal
Get a new signal handler
401 402 403 404 405 406 407 |
# File 'lib/libuv/reactor.rb', line 401 def signal(signum = nil, callback = nil, &block) callback ||= block handle = Signal.new(@reactor) handle.progress callback if callback handle.start(signum) if signum handle end |
#sleep(msecs) ⇒ Object
316 317 318 319 320 321 322 323 |
# File 'lib/libuv/reactor.rb', line 316 def sleep(msecs) fiber = Fiber.current time = timer { time.close fiber.resume }.start(msecs) Fiber.yield end |
#spawn(cmd, **args) ⇒ Object
472 473 474 |
# File 'lib/libuv/reactor.rb', line 472 def spawn(cmd, **args) Spawn.new(@reactor, cmd, **args) end |
#stop ⇒ Object
Closes handles opened by the reactor class and completes the current reactor iteration (thread safe)
518 519 520 |
# File 'lib/libuv/reactor.rb', line 518 def stop @stop_reactor.call end |
#tcp(callback = nil, **opts, &blk) ⇒ ::Libuv::TCP
Get a new TCP instance
328 329 330 |
# File 'lib/libuv/reactor.rb', line 328 def tcp(callback = nil, **opts, &blk) TCP.new(@reactor, progress: callback || blk, **opts) end |
#timer(callback = nil, &blk) ⇒ ::Libuv::Timer
Get a new timer instance
362 363 364 |
# File 'lib/libuv/reactor.rb', line 362 def timer(callback = nil, &blk) Timer.new(@reactor, callback || blk) end |
#tty(fileno, readable = false) ⇒ ::Libuv::TTY
Get a new TTY instance
344 345 346 347 348 |
# File 'lib/libuv/reactor.rb', line 344 def tty(fileno, readable = false) assert_type(Integer, fileno, "io#fileno must return an integer file descriptor, #{fileno.inspect} given") TTY.new(@reactor, fileno, readable) end |
#udp(callback = nil, **opts, &blk) ⇒ ::Libuv::UDP
Get a new UDP instance
335 336 337 |
# File 'lib/libuv/reactor.rb', line 335 def udp(callback = nil, **opts, &blk) UDP.new(@reactor, progress: callback || blk, **opts) end |
#unref ⇒ Object
Allows the reactor loop to stop
212 213 214 215 216 217 |
# File 'lib/libuv/reactor.rb', line 212 def unref if reactor_thread? && reactor_running? && @ref_count > 0 @ref_count -= 1 @process_queue.unref if @ref_count == 0 end end |
#update_time ⇒ Object
forces reactor time update, useful for getting more granular times
285 286 287 288 |
# File 'lib/libuv/reactor.rb', line 285 def update_time ::Libuv::Ext.update_time(@pointer) self end |
#work(callback = nil, &block) ⇒ ::Libuv::Work
Queue some work for processing in the libuv thread pool
420 421 422 423 424 |
# File 'lib/libuv/reactor.rb', line 420 def work(callback = nil, &block) callback ||= block assert_block(callback) Work.new(@reactor, callback) # Work is a promise object end |