Class: Roda::RodaPlugins::Streaming::Stream

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/roda/plugins/streaming.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.

Defined Under Namespace

Classes: Scheduler

Instance Method Summary collapse

Constructor Details

#initialize(opts = OPTS, &back) ⇒ Stream

Handle streaming options, see Streaming for details.



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/roda/plugins/streaming.rb', line 93

def initialize(opts=OPTS, &back)
  @scheduler = opts[:scheduler] || Scheduler.new(self)
  @back = back.to_proc
  @keep_open = opts[:keep_open]
  @callbacks = []
  @closed = false

  if opts[:callback]
    callback(&opts[:callback])
  end
end

Instance Method Details

#<<(data) ⇒ Object

Alias for write.



112
113
114
 
# File 'lib/roda/plugins/streaming.rb', line 112

def <<(data)
  write(data)
end

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

Add the given block as a callback to call when the block closes.



117
118
119
120
 
# File 'lib/roda/plugins/streaming.rb', line 117

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

#close ⇒ Object

If not already closed, close the connection, and call any callbacks.



127
128
129
130
131
 
# File 'lib/roda/plugins/streaming.rb', line 127

def close
  return if closed?
  @closed = true
  @scheduler.schedule{@callbacks.each(&:call)}
end

#closed? ⇒ Boolean

Whether the connection has already been closed.

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/roda/plugins/streaming.rb', line 134

def closed?
  @closed
end

#each(&front) ⇒ Object

Yield values to the block as they are passed in via #<<.



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/roda/plugins/streaming.rb', line 139

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

#write(data) ⇒ Object

Add output to the streaming response body.



106
107
108
109
 
# File 'lib/roda/plugins/streaming.rb', line 106

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