module Ethon::Easy::ResponseCallbacks

This module contains the logic for the response callbacks. The on_complete callback is the only one at the moment.

You can set multiple callbacks, which are then executed in the same order.

easy.on_complete { p 1 }
easy.on_complete { p 2 }
easy.complete
#=> 1
#=> 2

You can clear the callbacks:

easy.on_complete { p 1 }
easy.on_complete { p 2 }
easy.on_complete.clear
easy.on_complete
#=> []

Public Instance Methods

body(chunk) click to toggle source

Execute on_body callbacks.

@example Execute on_body.

request.body("This data came from HTTP.")

@return [ Object ] If there are no on_body callbacks, returns the symbol :unyielded.

# File lib/ethon/easy/response_callbacks.rb, line 122
def body(chunk)
  if defined?(@on_body) and not @on_body.nil?
    result = nil
    @on_body.each do |callback|
      result = callback.call(chunk, self)
      break if result == :abort
    end
    result
  else
    :unyielded
  end
end
complete() click to toggle source

Execute on_complete callbacks.

@example Execute on_completes.

request.complete
# File lib/ethon/easy/response_callbacks.rb, line 71
def complete
  headers unless @response_headers.empty?
  if defined?(@on_complete) and not @on_complete.nil?
    @on_complete.each{ |callback| callback.call(self) }
  end
end
headers() click to toggle source

Execute on_headers callbacks.

@example Execute on_headers.

request.headers
# File lib/ethon/easy/response_callbacks.rb, line 42
def headers
  return if @headers_called
  @headers_called = true
  if defined?(@on_headers) and not @on_headers.nil?
    result = nil
    @on_headers.each do |callback|
      result = callback.call(self)
      break if result == :abort
    end
    result
  end
end
on_body(&block) click to toggle source

Set on_body callback.

@example Set on_body.

request.on_body { |chunk| p "yay" }

@param [ Block ] block The block to execute.

# File lib/ethon/easy/response_callbacks.rb, line 110
def on_body(&block)
  @on_body ||= []
  @on_body << block if block_given?
  @on_body
end
on_complete(&block) click to toggle source

Set on_complete callback.

@example Set on_complete.

request.on_complete { p "yay" }

@param [ Block ] block The block to execute.

# File lib/ethon/easy/response_callbacks.rb, line 61
def on_complete(&block)
  @on_complete ||= []
  @on_complete << block if block_given?
  @on_complete
end
on_headers(&block) click to toggle source

Set on_headers callback.

@example Set on_headers.

request.on_headers { p "yay" }

@param [ Block ] block The block to execute.

# File lib/ethon/easy/response_callbacks.rb, line 32
def on_headers(&block)
  @on_headers ||= []
  @on_headers << block if block_given?
  @on_headers
end
on_progress(&block) click to toggle source

Set on_progress callback.

@example Set on_progress.

request.on_progress {|dltotal, dlnow, ultotal, ulnow| p "#{dltotal} #{dlnow} #{ultotal} #{ulnow}" }

@param [ Block ] block The block to execute.

# File lib/ethon/easy/response_callbacks.rb, line 84
def on_progress(&block)
  @on_progress ||= []
  if block_given?
    @on_progress << block
    set_progress_callback
    self.noprogress = 0
  end
  @on_progress
end
progress(dltotal, dlnow, ultotal, ulnow) click to toggle source

Execute on_progress callbacks.

@example Execute on_progress.

request.body(1, 1, 1, 1)
# File lib/ethon/easy/response_callbacks.rb, line 98
def progress(dltotal, dlnow, ultotal, ulnow)
  if defined?(@on_progress) and not @on_progress.nil?
    @on_progress.each{ |callback| callback.call(dltotal, dlnow, ultotal, ulnow) }
  end
end