Class: Rdkafka::Producer::DeliveryReport

Inherits:
Object
  • Object
show all
Defined in:
lib/rdkafka/producer/delivery_report.rb

Overview

Delivery report for a successfully produced message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(partition, offset, topic_name = nil, error = nil, label = nil) ⇒ DeliveryReport

Returns a new instance of DeliveryReport.

Parameters:

  • partition (Integer) —

    partition number

  • offset (Integer) —

    message offset

  • topic_name (String, nil) (defaults to: nil) —

    topic name

  • error (Integer, nil) (defaults to: nil) —

    error code if any

  • label (Object, nil) (defaults to: nil) —

    user-defined label



41
42
43
44
45
46
47
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 41

def initialize(partition, offset, topic_name = nil, error = nil, label = nil)
  @partition = partition
  @offset = offset
  @topic_name = topic_name
  @error = error
  @label = label
end

Instance Attribute Details

#error ⇒ Integer (readonly)

Error in case happen during produce.

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 23

def error
  @error
end

#label ⇒ Object? (readonly)

Returns label set during message production or nil by default.

Returns:

  • (Object, nil) —

    label set during message production or nil by default



26
27
28
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 26

def label
  @label
end

#offset ⇒ Integer (readonly)

The offset of the produced message.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 13

def offset
  @offset
end

#partition ⇒ Integer (readonly)

The partition this message was produced to.

Returns:

  • (Integer) 


9
10
11
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 9

def partition
  @partition
end

#topic_name ⇒ String? (readonly) Also known as: topic

The name of the topic this message was produced to or nil in case delivery failed and we

we not able to get the topic reference

Returns:

  • (String, nil) 


19
20
21
 
# File 'lib/rdkafka/producer/delivery_report.rb', line 19

def topic_name
  @topic_name
end