Class: Ably::Models::ConnectionStateChange

Inherits:

Object

• Object
• Ably::Models::ConnectionStateChange

Includes:

Ably::Modules::ModelCommon

Defined in:

lib/ably/models/connection_state_change.rb

Overview

ConnectionStateChange is a class that is emitted by the Realtime::Connection object when a state change occurs

Instance Attribute Summary

• #current ⇒ Connection::STATE readonly

  Current connection state.

• #previous ⇒ Connection::STATE readonly

  Previous connection state.

• #reason ⇒ Ably::Models::ErrorInfo readonly

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

• #retry_in ⇒ Integer readonly

  Time in seconds until the connection will reattempt to connect when in the :disconnected or :suspended state.

Attributes included from Ably::Modules::ModelCommon

#hash

Instance Method Summary

• #initialize(hash_object) ⇒ ConnectionStateChange constructor

  A new instance of ConnectionStateChange.

• #to_s ⇒ Object

Methods included from Ably::Modules::ModelCommon

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

Methods included from Ably::Modules::MessagePack

#to_msgpack

Constructor Details

#initialize(hash_object) ⇒ ConnectionStateChange

# File 'lib/ably/models/connection_state_change.rb', line 17

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

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

Instance Attribute Details

#current ⇒ Connection::STATE (readonly)

# File 'lib/ably/models/connection_state_change.rb', line 14

class ConnectionStateChange
  include Ably::Modules::ModelCommon

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

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

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

  def to_s
    "<ConnectionStateChange: current state #{current}, previous state #{previous}>"
  end
end

#previous ⇒ Connection::STATE (readonly)

# File 'lib/ably/models/connection_state_change.rb', line 14

class ConnectionStateChange
  include Ably::Modules::ModelCommon

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

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

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

  def to_s
    "<ConnectionStateChange: current state #{current}, previous state #{previous}>"
  end
end

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

# File 'lib/ably/models/connection_state_change.rb', line 14

class ConnectionStateChange
  include Ably::Modules::ModelCommon

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

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

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

  def to_s
    "<ConnectionStateChange: current state #{current}, previous state #{previous}>"
  end
end

#retry_in ⇒ Integer (readonly)

# File 'lib/ably/models/connection_state_change.rb', line 14

class ConnectionStateChange
  include Ably::Modules::ModelCommon

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

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

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

  def to_s
    "<ConnectionStateChange: current state #{current}, previous state #{previous}>"
  end
end

Instance Method Details

#to_s ⇒ Object

# File 'lib/ably/models/connection_state_change.rb', line 40

def to_s
  "<ConnectionStateChange: current state #{current}, previous state #{previous}>"
end