Module: WaterDrop::Producer::Buffer

Included in:
WaterDrop::Producer
Defined in:
lib/waterdrop/producer/buffer.rb

Overview

Component for buffered operations

Instance Method Summary collapse

Instance Method Details

#buffer(message) ⇒ Object

Adds given message into the internal producer buffer without flushing it to Kafka

Parameters:

Raises:



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

def buffer(message)
  ensure_active!

  # The append runs under @buffer_mutex because flush/purge/close swap @messages for a fresh
  # array under the same lock. Without it, a concurrent swap between reading @messages and
  # appending would land the message in the orphaned old array and silently lose it.
  @monitor.instrument(
    "message.buffered",
    producer_id: id,
    message: message,
    buffer: @messages
  ) { @buffer_mutex.synchronize { @messages << message } }
end

#buffer_many(messages) ⇒ Object

Adds given messages into the internal producer buffer without flushing them to Kafka

Parameters:

  • messages (Array<Hash>) —

    array with messages that comply with the Contracts::Message contract

Raises:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/waterdrop/producer/buffer.rb', line 32

def buffer_many(messages)
  ensure_active!

  # The concat runs under @buffer_mutex for the same reason as #buffer: flush/purge/close swap
  # @messages under the lock, so an unguarded concat could append into an array that has just
  # been captured for dispatch (or discarded), silently losing the messages.
  @monitor.instrument(
    "messages.buffered",
    producer_id: id,
    messages: messages,
    buffer: @messages
  ) do
    @buffer_mutex.synchronize { @messages.concat(messages) }
    messages
  end
end

#flush_async ⇒ Array<Rdkafka::Producer::DeliveryHandle>

Flushes the internal buffer to Kafka in an async way

Returns:

  • (Array<Rdkafka::Producer::DeliveryHandle>) —

    delivery handles for messages that were flushed



52
53
54
55
56
57
58
 
# File 'lib/waterdrop/producer/buffer.rb', line 52

def flush_async
  @monitor.instrument(
    "buffer.flushed_async",
    producer_id: id,
    messages: @messages
  ) { flush(false) }
end

#flush_sync ⇒ Array<Rdkafka::Producer::DeliveryHandle>

Flushes the internal buffer to Kafka in a sync way

Returns:

  • (Array<Rdkafka::Producer::DeliveryHandle>) —

    delivery handles for messages that were flushed (handles are in final state, call ‘#create_result` to get delivery report)



63
64
65
66
67
68
69
 
# File 'lib/waterdrop/producer/buffer.rb', line 63

def flush_sync
  @monitor.instrument(
    "buffer.flushed_sync",
    producer_id: id,
    messages: @messages
  ) { flush(true) }
end