Class: Sinatra::Helpers::Stream

Inherits:
Object
  • Object
show all
Defined in:
lib/sinatra/base.rb

Overview

Class of the response body in case you use #stream.

Three things really matter: The front and back block (back being the block generating content, front the one sending it to the client) and the scheduler, integrating with whatever concurrency feature the Rack handler is using.

Scheduler has to respond to defer and schedule.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scheduler = self.class, keep_open = false, &back) ⇒ Stream

Returns a new instance of Stream.



440
441
442
443
 
# File 'lib/sinatra/base.rb', line 440

def initialize(scheduler = self.class, keep_open = false, &back)
  @back, @scheduler, @keep_open = back.to_proc, scheduler, keep_open
  @callbacks, @closed = [], false
end

Class Method Details

.defer ⇒ Object 



438
 
# File 'lib/sinatra/base.rb', line 438

def self.defer(*)    yield end

.schedule ⇒ Object 



437
 
# File 'lib/sinatra/base.rb', line 437

def self.schedule(*) yield end

Instance Method Details

#<<(data) ⇒ Object 



463
464
465
466
 
# File 'lib/sinatra/base.rb', line 463

def <<(data)
  @scheduler.schedule { @front.call(data.to_s) }
  self
end

#callback(&block) ⇒ Object Also known as: errback 



468
469
470
471
 
# File 'lib/sinatra/base.rb', line 468

def callback(&block)
  return yield if closed?
  @callbacks << block
end

#close ⇒ Object 



445
446
447
448
449
 
# File 'lib/sinatra/base.rb', line 445

def close
  return if closed?
  @closed = true
  @scheduler.schedule { @callbacks.each { |c| c.call } }
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


475
476
477
 
# File 'lib/sinatra/base.rb', line 475

def closed?
  @closed
end

#each(&front) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/sinatra/base.rb', line 451

def each(&front)
  @front = front
  @scheduler.defer do
    begin
      @back.call(self)
    rescue Exception => e
      @scheduler.schedule { raise e }
    end
    close unless @keep_open
  end
end