Module: HTTPX::Plugins::Callbacks::InstanceMethods

Includes:
Callbacks
Defined in:
lib/httpx/plugins/callbacks.rb,
sig/plugins/callbacks.rbs

Overview

rubocop:disable Lint/InheritException

Instance Method Summary collapse

Methods included from Callbacks

#callbacks, #callbacks_for?, #emit, #on, #once

Instance Method Details

#emit_or_callback_error(*args) ⇒ void

This method returns an undefined value.

Parameters:

  • (Object) 


104
105
106
107
108
109
110
 
# File 'lib/httpx/plugins/callbacks.rb', line 104

def emit_or_callback_error(*args)
  emit(*args)
rescue StandardError => e
  ex = CallbackError.new(e.message)
  ex.set_backtrace(e.backtrace)
  raise ex
end

#on_connection_closed {|origin| ... } ⇒ self

Yields:

Yield Parameters:

  • origin (http_uri)

Yield Returns:

  • (void)

Returns:

  • (self) 


14
 
# File 'sig/plugins/callbacks.rbs', line 14

def on_connection_closed: () { (http_uri origin) -> void } -> self

#on_connection_opened {|origin, sock| ... } ⇒ self

Yields:

Yield Parameters:

  • origin (http_uri)
  • sock (socket)

Yield Returns:

  • (void)

Returns:

  • (self) 


12
 
# File 'sig/plugins/callbacks.rbs', line 12

def on_connection_opened: () { (http_uri origin, socket sock) -> void } -> self

#on_request_body_chunk {|request, chunk| ... } ⇒ self

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (self) 


20
 
# File 'sig/plugins/callbacks.rbs', line 20

def on_request_body_chunk: () { (Request request, String chunk) -> void } -> self

#on_request_completed {|request| ... } ⇒ self

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (self) 


22
 
# File 'sig/plugins/callbacks.rbs', line 22

def on_request_completed: () { (Request request) -> void } -> self

#on_request_error {|request, error| ... } ⇒ self

Yields:

Yield Parameters:

  • request (Request)
  • error (StandardError)

Yield Returns:

  • (void)

Returns:

  • (self) 


16
 
# File 'sig/plugins/callbacks.rbs', line 16

def on_request_error: () { (Request request, StandardError error) -> void } -> self

#on_request_started {|request| ... } ⇒ self

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (self) 


18
 
# File 'sig/plugins/callbacks.rbs', line 18

def on_request_started: () { (Request request) -> void } -> self

#on_response_body_chunk {|request, response, chunk| ... } ⇒ self

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (self) 


26
 
# File 'sig/plugins/callbacks.rbs', line 26

def on_response_body_chunk: () { (Request request, Response response, String chunk) -> void } -> self

#on_response_completed {|request, response| ... } ⇒ self

Yields:

Yield Parameters:

  • request (Request)
  • response (response)

Yield Returns:

  • (void)

Returns:

  • (self) 


28
 
# File 'sig/plugins/callbacks.rbs', line 28

def on_response_completed: () { (Request request, response response) -> void } -> self

#on_response_started {|request, response| ... } ⇒ self

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (self) 


24
 
# File 'sig/plugins/callbacks.rbs', line 24

def on_response_started: () { (Request request, Response response) -> void } -> self

#plugin(*args, &blk) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/httpx/plugins/callbacks.rb', line 35

def plugin(*args, &blk)
  super(*args).tap do |sess|
    CALLBACKS.each do |cb|
      next unless callbacks_for?(cb)

      sess.callbacks(cb).concat(callbacks(cb))
    end

    sess.wrap(&blk) if blk
  end
end