Exception: Kafka::ResponseError

Inherits:
Error
  • Object
show all
Defined in:
lib/kafka/error.rb

Overview

::Kafka::ResponseError is an Error that can be raised based on an :error_code as returned from the librdkafka API.

See Also:

  • RD_KAFKA_RESP_ERR_*
  • rd_kafka_resp_err_t

Direct Known Subclasses

QueueFullError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code, message = nil) ⇒ ResponseError

Returns a new instance of ResponseError.



35
36
37
38
 
# File 'lib/kafka/error.rb', line 35

def initialize(code, message = nil)
  @code = code
  @message = message
end

Instance Attribute Details

#code ⇒ Object (readonly) 



33
34
35
 
# File 'lib/kafka/error.rb', line 33

def code
  @code
end

Class Method Details

.exception(code) ⇒ Object

exception is called instead of ‘new` when using the form:

raise Kafka::ResponseError, code



28
29
30
 
# File 'lib/kafka/error.rb', line 28

def self.exception(code)
  new(code)
end

.new(code, message = nil) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/kafka/error.rb', line 12

def self.new(code, message = nil)
  klass =
    case code
    when Kafka::FFI::RD_KAFKA_RESP_ERR__QUEUE_FULL
      QueueFullError
    else
      ResponseError
    end

  error = klass.allocate
  error.send(:initialize, code, message)
  error
end

Instance Method Details

#internal? ⇒ true, false

Returns true when the error is from internal to librdkafka or false when the error was received from a broker or timeout.

Returns:

  • (true) —

    Error was internal to librdkafka

  • (false) —

    Error was returned by the cluster

See Also:



53
54
55
 
# File 'lib/kafka/error.rb', line 53

def internal?
  code < 0
end

#name ⇒ String

Returns the librdkafka error constant for this error.

Returns:

  • (String) 


42
43
44
 
# File 'lib/kafka/error.rb', line 42

def name
  "RD_KAFKA_RESP_ERR_#{::Kafka::FFI.rd_kafka_err2name(@code)}"
end

#to_s ⇒ String

Returns a human readable error description

Returns:

  • (String) —

    Human readable description of the error.



60
61
62
 
# File 'lib/kafka/error.rb', line 60

def to_s
  @message || ::Kafka::FFI.rd_kafka_err2str(@code)
end