Method: Kafka::FFI::Message#key

Defined in:
lib/kafka/ffi/message.rb

#key ⇒ nil, String

Returns the optional message key used to publish the message. This key is used for partition assignment based on the ‘partitioner` or `partitioner_cb` config options.

Returns:

  • (nil) —

    No partitioning key was provided

  • (String) —

    The partitioning key



50
51
52
53
54
55
56
 
# File 'lib/kafka/ffi/message.rb', line 50

def key
  if self[:key].null?
    return nil
  end

  self[:key].read_string(self[:key_len])
end