Class: Ably::Models::ChannelStateChange

Inherits:
Object
  • Object
show all
Includes:
Ably::Modules::ModelCommon
Defined in:
lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb

Overview

ChannelStateChange is a class that is emitted by the Realtime::Channel object when a state change occurs

Instance Attribute Summary collapse

Attributes included from Ably::Modules::ModelCommon

#hash

Instance Method Summary collapse

Methods included from Ably::Modules::ModelCommon

#==, #[], #as_json, included, #to_json

Methods included from Ably::Modules::MessagePack

#to_msgpack

Constructor Details

#initialize(hash_object) ⇒ ChannelStateChange

Returns a new instance of ChannelStateChange.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb', line 15

def initialize(hash_object)
  unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
    raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
  end

  @hash_object = {
    current: hash_object.fetch(:current),
    previous: hash_object.fetch(:previous),
    reason: hash_object[:reason],
    protocol_message: hash_object[:protocol_message]
  }
rescue KeyError => e
  raise ArgumentError, e
end

Instance Attribute Details

#current ⇒ Connection::STATE (readonly)

Returns Current channel state.

Returns:

  • (Connection::STATE) —

    Current channel state



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb', line 12

class ChannelStateChange
  include Ably::Modules::ModelCommon

  def initialize(hash_object)
    unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
      raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
    end

    @hash_object = {
      current: hash_object.fetch(:current),
      previous: hash_object.fetch(:previous),
      reason: hash_object[:reason],
      protocol_message: hash_object[:protocol_message]
    }
  rescue KeyError => e
    raise ArgumentError, e
  end

  %w(current previous reason protocol_message).each do |attribute|
    define_method attribute do
      @hash_object[attribute.to_sym]
    end
  end

  def to_s
    "ChannelStateChange: current state #{current}, previous state #{previous}"
  end
end

#previous ⇒ Connection::STATE (readonly)

Returns Previous channel state.

Returns:

  • (Connection::STATE) —

    Previous channel state



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb', line 12

class ChannelStateChange
  include Ably::Modules::ModelCommon

  def initialize(hash_object)
    unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
      raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
    end

    @hash_object = {
      current: hash_object.fetch(:current),
      previous: hash_object.fetch(:previous),
      reason: hash_object[:reason],
      protocol_message: hash_object[:protocol_message]
    }
  rescue KeyError => e
    raise ArgumentError, e
  end

  %w(current previous reason protocol_message).each do |attribute|
    define_method attribute do
      @hash_object[attribute.to_sym]
    end
  end

  def to_s
    "ChannelStateChange: current state #{current}, previous state #{previous}"
  end
end

#reason ⇒ Ably::Models::ErrorInfo (readonly)

Returns Object describing the reason for a state change when not initiated by the consumer of the client library.

Returns:

  • (Ably::Models::ErrorInfo) —

    Object describing the reason for a state change when not initiated by the consumer of the client library



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb', line 12

class ChannelStateChange
  include Ably::Modules::ModelCommon

  def initialize(hash_object)
    unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
      raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
    end

    @hash_object = {
      current: hash_object.fetch(:current),
      previous: hash_object.fetch(:previous),
      reason: hash_object[:reason],
      protocol_message: hash_object[:protocol_message]
    }
  rescue KeyError => e
    raise ArgumentError, e
  end

  %w(current previous reason protocol_message).each do |attribute|
    define_method attribute do
      @hash_object[attribute.to_sym]
    end
  end

  def to_s
    "ChannelStateChange: current state #{current}, previous state #{previous}"
  end
end

Instance Method Details

#to_s ⇒ Object 



36
37
38
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb', line 36

def to_s
  "ChannelStateChange: current state #{current}, previous state #{previous}"
end