Class: KubeMQ::PubSub::EventSendResult

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

Overview

Result returned after sending an event via KubeMQ::PubSubClient#send_event.

Check #sent to confirm the broker accepted 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) ⇒ EventSendResult

Returns a new instance of EventSendResult.

Parameters:

  • id (String) —

    event identifier

  • sent (Boolean) —

    whether the event was accepted

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

    error description on failure



24
25
26
27
28
 
# File 'lib/kubemq/pubsub/event_send_result.rb', line 24

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.



19
 
# File 'lib/kubemq/pubsub/event_send_result.rb', line 19

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



19
20
21
 
# File 'lib/kubemq/pubsub/event_send_result.rb', line 19

def id
  @id
end

#sent ⇒ Boolean (readonly)

Returns true if the broker accepted the event.

Returns:

  • (Boolean) —

    true if the broker accepted the event



19
 
# File 'lib/kubemq/pubsub/event_send_result.rb', line 19

attr_reader :id, :sent, :error