Class: Rdkafka::Admin::DescribeConfigsHandle

Inherits:

Rdkafka::AbstractHandle

• Object
• FFI::Struct
• Rdkafka::AbstractHandle
• Rdkafka::Admin::DescribeConfigsHandle

Defined in:

lib/rdkafka/admin/describe_configs_handle.rb

Overview

Handle for describe configs operation

Constant Summary

Constants inherited from Rdkafka::AbstractHandle

Rdkafka::AbstractHandle::REGISTRY

Instance Attribute Summary

Attributes inherited from Rdkafka::AbstractHandle

#broker_message, #result

Instance Method Summary

• #create_result ⇒ DescribeConfigsReport

  Report prepared by the background event callback.

• #operation_name ⇒ String

  The name of the operation.

• #raise_error ⇒ Object

  Raises an error if the operation failed.

Methods inherited from Rdkafka::AbstractHandle

#initialize, #pending?, #prepared_result, register, remove, #unlock, #wait

Methods included from Helpers::Time

#monotonic_now, #monotonic_now_ms

Constructor Details

This class inherits a constructor from Rdkafka::AbstractHandle

Instance Method Details

#create_result ⇒ DescribeConfigsReport

Returns report prepared by the background event callback.

Returns:

• (DescribeConfigsReport) —

  report prepared by the background event callback

# File 'lib/rdkafka/admin/describe_configs_handle.rb', line 16

def create_result
  prepared_result
end

#operation_name ⇒ String

Returns the name of the operation.

Returns:

• (String) —

  the name of the operation.

# File 'lib/rdkafka/admin/describe_configs_handle.rb', line 11

def operation_name
  "describe configs"
end

#raise_error ⇒ Object

Raises an error if the operation failed

Raises:

• (RdkafkaError)

# File 'lib/rdkafka/admin/describe_configs_handle.rb', line 22

def raise_error
  raise RdkafkaError.new(
    self[:response],
    broker_message: broker_message
  )
end