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.



464
465
466
467
468
469
470
 
# File 'lib/sinatra/base.rb', line 464

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

Class Method Details

.defer ⇒ Object 



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

def self.defer(*)    yield end

.schedule ⇒ Object 



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

def self.schedule(*) yield end

Instance Method Details

#<<(data) ⇒ Object 



492
493
494
495
 
# File 'lib/sinatra/base.rb', line 492

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

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



497
498
499
500
501
 
# File 'lib/sinatra/base.rb', line 497

def callback(&block)
  return yield if closed?

  @callbacks << block
end

#close ⇒ Object 



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

def close
  return if closed?

  @closed = true
  @scheduler.schedule { @callbacks.each { |c| c.call } }
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


505
506
507
 
# File 'lib/sinatra/base.rb', line 505

def closed?
  @closed
end

#each(&front) ⇒ Object 



479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/sinatra/base.rb', line 479

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