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.



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/roda/plugins/streaming.rb', line 112

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.



131
132
133
 
# File 'lib/roda/plugins/streaming.rb', line 131

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.



136
137
138
139
 
# File 'lib/roda/plugins/streaming.rb', line 136

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

#close ⇒ Object

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



146
147
148
149
150
 
# File 'lib/roda/plugins/streaming.rb', line 146

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

#closed? ⇒ Boolean

Whether the connection has already been closed.

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/roda/plugins/streaming.rb', line 153

def closed?
  @closed
end

#each(&front) ⇒ Object

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



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/roda/plugins/streaming.rb', line 158

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.



125
126
127
128
 
# File 'lib/roda/plugins/streaming.rb', line 125

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