Module: Qpid::Proton::Util::ErrorHandler

Included in:
SSL, SSLDomain, Sender, Terminus, Transport
Defined in:
lib/util/error_handler.rb

Overview

Provides mixin functionality for dealing with exception conditions.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(other) ⇒ Object 



26
 
# File 'lib/util/error_handler.rb', line 26

def self.included(other) other.extend(self); end

Instance Method Details

#can_raise_error(method_names, options = {}) ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/util/error_handler.rb', line 28

def can_raise_error(method_names, options = {})
  error_class = options[:error_class]
  below = options[:below] || 0
  # coerce the names to be an array
  Array(method_names).each do |method_name|
    raise "missing method #{method_name.inspect}" unless method_defined?(method_name) || private_method_defined?(method_name)
    create_exception_handler_wrapper(method_name, error_class, below)
  end
end

#check_for_error(code, error_class = nil) ⇒ Object

Raises an Proton-specific error if a return code is non-zero.

Expects the class to provide an error method.

Raises:

  • (::ArgumentError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/util/error_handler.rb', line 55

def check_for_error(code, error_class = nil)

  raise ::ArgumentError.new("Invalid error code: #{code}") if code.nil?

  return code if code > 0

  case(code)

  when Qpid::Proton::Error::NONE
    return

  when Qpid::Proton::Error::EOS
    raise Qpid::Proton::EOSError.new(self.error)

  when Qpid::Proton::Error::ERROR
    raise Qpid::Proton::ProtonError.new(self.error)

  when Qpid::Proton::Error::OVERFLOW
    raise Qpid::Proton::OverflowError.new(self.error)

  when Qpid::Proton::Error::UNDERFLOW
    raise Qpid::Proton::UnderflowError.new(self.error)

  when Qpid::Proton::Error::ARGUMENT
    raise Qpid::Proton::ArgumentError.new(self.error)

  when Qpid::Proton::Error::STATE
    raise Qpid::Proton::StateError.new(self.error)

  when Qpid::Proton::Error::TIMEOUT
    raise Qpid::Proton::TimeoutError.new(self.error)

  when Qpid::Proton::Error::INPROGRESS
    return

  when Qpid::Proton::Error::INTERRUPTED
    raise Qpid::Proton::InterruptedError.new(self.error)

  when Qpid::Proton::Error::INPROGRESS
    raise Qpid::Proton::InProgressError.new(self.error)

  else

    raise ::ArgumentError.new("Unknown error code: #{code}")

  end

end

#create_exception_handler_wrapper(method_name, error_class = nil, below = 0) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/util/error_handler.rb', line 38

def create_exception_handler_wrapper(method_name, error_class = nil, below = 0)
  original_method_name = method_name.to_s
  wrapped_method_name = "_excwrap_#{original_method_name}"
  alias_method wrapped_method_name, original_method_name
  define_method original_method_name do |*args, &block|
    # need to get a reference to the method object itself since
    # calls to Class.send interfere with Messenger.send
    method = self.method(wrapped_method_name.to_sym)
    rc = method.call(*args, &block)
    check_for_error(rc, error_class) if rc < below
    return rc
  end
end