Class: Libuv::Reactor

Inherits:
Object show all
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

Accessors::Functions

Constants included from Assertions

Assertions::MSG_NO_PROC

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Accessors

reactor

Methods included from ClassMethods

create, current, default, new

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 { process_queue_cb }
    @process_queue.unref

    # Create a next tick timer
    @next_tick = @reactor.timer { next_tick_cb }
    @next_tick.unref

    # Create an async call for ending the reactor
    @stop_reactor = @reactor.async { 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 = prepare {}
    @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 = proc { 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



218
219
220
221
 
# File 'lib/libuv/reactor.rb', line 218

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)

Parameters:

  • *promises (::Libuv::Q::Promise) —

    a number of promises that will be combined into a single promise

Returns:

  • (::Libuv::Q::Promise) —

    Returns a single promise that will be resolved with an array of values, each value corresponding to the promise at the same index in the ‘promises` array. If any of the promises is resolved with a rejection, this resulting promise will be resolved with the same rejection.



252
253
254
 
# File 'lib/libuv/reactor.rb', line 252

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.

Parameters:

  • *promises (::Libuv::Q::Promise) —

    a number of promises that will be combined into a single promise

Returns:



262
263
264
 
# File 'lib/libuv/reactor.rb', line 262

def any(*promises)
    Q.any(@reactor, *promises)
end

#async ⇒ ::Libuv::Async

Get a new Async handle

Returns:



401
402
403
404
405
 
# File 'lib/libuv/reactor.rb', line 401

def async
    handle = Async.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle
end

#check ⇒ ::Libuv::Check

Get a new Check handle

Returns:



382
383
384
385
386
 
# File 'lib/libuv/reactor.rb', line 382

def check
    handle = Check.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle
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)

Returns:



240
241
242
 
# File 'lib/libuv/reactor.rb', line 240

def defer
    Q.defer(@reactor)
end

#exec ⇒ Object

Execute the provided block of code in a fiber from the pool



197
198
199
 
# File 'lib/libuv/reactor.rb', line 197

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

Parameters:

  • path (String) —

    the path to the file or folder for watching

  • flags (Integer) (defaults to: 0) —

    see ruby File::Constants

  • mode (Integer) (defaults to: 0)

Returns:



465
466
467
468
469
470
 
# File 'lib/libuv/reactor.rb', line 465

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

Returns:



475
476
477
 
# File 'lib/libuv/reactor.rb', line 475

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.

Parameters:

  • *promises (::Libuv::Q::Promise) —

    a number of promises that will be combined into a single promise

Returns:

  • (::Libuv::Q::Promise) —

    Returns a single promise that will be resolved with an array of values, each [result, wasResolved] value pair corresponding to a at the same index in the ‘promises` array.



273
274
275
 
# File 'lib/libuv/reactor.rb', line 273

def finally(*promises)
    Q.finally(@reactor, *promises)
end

#fs_event(path) ⇒ ::Libuv::FSEvent

Get a new FSEvent instance

Parameters:

  • path (String) —

    the path to the file or folder for watching

Returns:

Raises:

  • (ArgumentError) —

    if path is not a string



454
455
456
457
 
# File 'lib/libuv/reactor.rb', line 454

def fs_event(path)
    assert_type(String, path)
    FSEvent.new(@reactor, path)
end

#handle ⇒ Object 



155
 
# File 'lib/libuv/reactor.rb', line 155

def handle; @pointer; end

#idle ⇒ ::Libuv::Idle

Get a new Idle handle

Parameters:

  • callback (Proc) —

    the callback to be called on idle trigger

Returns:



392
393
394
395
396
 
# File 'lib/libuv/reactor.rb', line 392

def idle
    handle = Idle.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle
end

#inspect ⇒ Object

Overwrite as errors in jRuby can literally hang VM when inspecting as many many classes will reference this class



150
151
152
 
# File 'lib/libuv/reactor.rb', line 150

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

Parameters:

  • error (Exception) —

    the error

  • msg (String|nil) (defaults to: nil) —

    optional context on the error

  • trace (Array<String>) (defaults to: nil) —

    optional additional trace of caller if async



520
521
522
 
# File 'lib/libuv/reactor.rb', line 520

def log(error, msg = nil, trace = nil)
    @reactor_notify.call(error, msg, trace)
end

#lookup(hostname, hint = :IPv4, port = 9, wait: true) ⇒ ::Libuv::Dns

Lookup a hostname

Parameters:

  • hostname (String) —

    the domain name to lookup

  • port (Integer, String) (defaults to: 9) —

    the service being connected too

  • callback (Proc) —

    the callback to be called on success

Returns:



439
440
441
442
443
444
445
446
447
 
# File 'lib/libuv/reactor.rb', line 439

def lookup(hostname, hint = :IPv4, port = 9, wait: true)
    dns = Dns.new(@reactor, hostname, port, hint, wait: wait)    # Work is a promise object
    if wait
        dns.results
    else
        dns.then &Proc.new if block_given?
        dns
    end
end

#lookup_error(err) ⇒ ::Libuv::Error

Lookup an error code and return is as an error object

Parameters:

  • err (Integer) —

    The error code to look up.

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/libuv/reactor.rb', line 303

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)

Parameters:

  • callback (Proc) —

    the callback to be called on the reactor thread



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/libuv/reactor.rb', line 499

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 ⇒ ::Libuv::Q::Promise

Provides a promise notifier for receiving un-handled exceptions

Returns:



227
228
229
230
231
232
233
234
 
# File 'lib/libuv/reactor.rb', line 227

def notifier
    @reactor_notify = if block_given?
        Proc.new
    else
        @reactor_notify_default
    end
    self
end

#now ⇒ Integer

Get current time in milliseconds

Returns:

  • (Integer) 


295
296
297
 
# File 'lib/libuv/reactor.rb', line 295

def now
    ::Libuv::Ext.now(@pointer)
end

#on_program_interrupt(&callback) ⇒ Object

Allows user defined behaviour when sig int is received



418
419
420
421
 
# File 'lib/libuv/reactor.rb', line 418

def on_program_interrupt(&callback)
    @on_signal << callback
    self
end

#pipe(ipc = false) ⇒ ::Libuv::Pipe

Get a new Pipe instance

Parameters:

  • ipc (true, false) (defaults to: false) —

    indicate if a handle will be used for ipc, useful for sharing tcp socket between processes

Returns:



356
357
358
 
# File 'lib/libuv/reactor.rb', line 356

def pipe(ipc = false)
    Pipe.new(@reactor, ipc)
end

#prepare ⇒ ::Libuv::Prepare

Get a new Prepare handle

Returns:



373
374
375
376
377
 
# File 'lib/libuv/reactor.rb', line 373

def prepare
    handle = Prepare.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle
end

#reactor_running? ⇒ Boolean Also known as: running?

Tells you whether the Libuv reactor reactor is currently running.

Returns:

  • (Boolean) 


539
540
541
 
# File 'lib/libuv/reactor.rb', line 539

def reactor_running?
    @reactor_running
end

#reactor_thread? ⇒ Boolean

True if the calling thread is the same thread as the reactor.

Returns:

  • (Boolean) 


532
533
534
 
# File 'lib/libuv/reactor.rb', line 532

def reactor_thread?
    self == Thread.current.thread_variable_get(:reactor)
end

#ref ⇒ Object

Prevents the reactor loop from stopping



202
203
204
205
206
207
 
# File 'lib/libuv/reactor.rb', line 202

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.



280
281
282
 
# File 'lib/libuv/reactor.rb', line 280

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.

Parameters:

  • run_type (:UV_RUN_DEFAULT, :UV_RUN_ONCE, :UV_RUN_NOWAIT) (defaults to: :UV_RUN_DEFAULT)

Yield Parameters:

  • promise (::Libuv::Q::Promise) —

    Yields a promise that can be used for logging unhandled exceptions on the reactor.



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
 
# File 'lib/libuv/reactor.rb', line 162

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)

Yields:

  • the callback to be called on the reactor thread



486
487
488
489
490
491
492
493
494
 
# File 'lib/libuv/reactor.rb', line 486

def schedule
    if reactor_thread?
        yield
    else
        @run_queue << Proc.new
        @process_queue.call
    end
    self
end

#signal(signum = nil) ⇒ ::Libuv::Signal

Get a new signal handler

Returns:



410
411
412
413
414
415
 
# File 'lib/libuv/reactor.rb', line 410

def signal(signum = nil)
    handle = Signal.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle.start(signum) if signum
    handle
end

#sleep(msecs) ⇒ Object 



318
319
320
321
322
323
324
325
 
# File 'lib/libuv/reactor.rb', line 318

def sleep(msecs)
    fiber = Fiber.current
    time = timer {
        time.close
        fiber.resume
    }.start(msecs)
    Fiber.yield
end

#spawn(cmd, **args) ⇒ Object 



479
480
481
 
# File 'lib/libuv/reactor.rb', line 479

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)



525
526
527
 
# File 'lib/libuv/reactor.rb', line 525

def stop
    @stop_reactor.call
end

#tcp(**opts, &callback) ⇒ ::Libuv::TCP

Get a new TCP instance

Returns:



330
331
332
 
# File 'lib/libuv/reactor.rb', line 330

def tcp(**opts, &callback)
    TCP.new(@reactor, progress: callback, **opts)
end

#timer ⇒ ::Libuv::Timer

Get a new timer instance

Parameters:

  • callback (Proc) —

    the callback to be called on timer trigger

Returns:



364
365
366
367
368
 
# File 'lib/libuv/reactor.rb', line 364

def timer
    handle = Timer.new(@reactor)
    handle.progress &Proc.new if block_given?
    handle
end

#tty(fileno, readable = false) ⇒ ::Libuv::TTY

Get a new TTY instance

Parameters:

  • fileno (Integer) —

    Integer file descriptor of a tty device

  • readable (true, false) (defaults to: false) —

    Boolean indicating if TTY is readable

Returns:



346
347
348
349
350
 
# File 'lib/libuv/reactor.rb', line 346

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(**opts, &callback) ⇒ ::Libuv::UDP

Get a new UDP instance

Returns:



337
338
339
 
# File 'lib/libuv/reactor.rb', line 337

def udp(**opts, &callback)
    UDP.new(@reactor, progress: callback, **opts)
end

#unref ⇒ Object

Allows the reactor loop to stop



210
211
212
213
214
215
 
# File 'lib/libuv/reactor.rb', line 210

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

Returns:

  • nil



287
288
289
290
 
# File 'lib/libuv/reactor.rb', line 287

def update_time
    ::Libuv::Ext.update_time(@pointer)
    self
end

#work(&callback) ⇒ ::Libuv::Work

Queue some work for processing in the libuv thread pool

Parameters:

  • callback (Proc) —

    the callback to be called in the thread pool

Returns:

Raises:

  • (ArgumentError) —

    if block is not given



428
429
430
431
 
# File 'lib/libuv/reactor.rb', line 428

def work(&callback)
    assert_block(callback)
    Work.new(@reactor, &callback)
end