Class: KubeMQ::PubSub::EventStoreResult

Inherits:
Object
  • Object
show all
Defined in:
lib/kubemq/pubsub/event_store_result.rb

Overview

Result returned after sending a durable event via KubeMQ::PubSubClient#send_event_store or KubeMQ::PubSub::EventStoreSender#publish.

Check #sent to confirm the broker persisted the event. If sent is false, inspect #error for the reason.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, sent:, error: nil) ⇒ EventStoreResult

Returns a new instance of EventStoreResult.

Parameters:

  • id (String) —

    event identifier

  • sent (Boolean) —

    whether the event was persisted

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

    error description on failure



26
27
28
29
30
 
# File 'lib/kubemq/pubsub/event_store_result.rb', line 26

def initialize(id:, sent:, error: nil)
  @id = id
  @sent = sent
  @error = error
end

Instance Attribute Details

#error ⇒ Object (readonly)

Returns the value of attribute error.



21
 
# File 'lib/kubemq/pubsub/event_store_result.rb', line 21

attr_reader :id, :sent, :error

#id ⇒ String (readonly)

Returns the event identifier echoed back by the broker.

Returns:

  • (String) —

    the event identifier echoed back by the broker



21
22
23
 
# File 'lib/kubemq/pubsub/event_store_result.rb', line 21

def id
  @id
end

#sent ⇒ Boolean (readonly)

Returns true if the broker persisted the event.

Returns:

  • (Boolean) —

    true if the broker persisted the event



21
 
# File 'lib/kubemq/pubsub/event_store_result.rb', line 21

attr_reader :id, :sent, :error