Exception: Rbeapi::Eapilib::ConnectionError

Inherits:
EapiError
  • Object
show all
Defined in:
lib/rbeapi/eapilib.rb

Overview

A ConnectionError exception is raised when the connection object is unable to establish a connection with eAPI.

Instance Attribute Summary collapse

Attributes inherited from EapiError

#commands

Instance Method Summary collapse

Methods inherited from EapiError

#initalize

Constructor Details

#initialize(message, connection_type = nil, commands = nil) ⇒ ConnectionError

The exception contains the eAPI error code and error text.

Parameters:

  • message (String) —

    The error message to return from raising this exception.

  • connection_type (String) (defaults to: nil) —

    The optional connection_type of the instance.

  • commands (Array) (defaults to: nil) —

    The list of commands that were used in the eAPI request message.



114
115
116
117
118
 
# File 'lib/rbeapi/eapilib.rb', line 114

def initialize(message, connection_type = nil, commands = nil)
  @connection_type = connection_type
  @commands = commands
  super(message)
end

Instance Attribute Details

#connection_type ⇒ Object

Returns the value of attribute connection_type.



101
102
103
 
# File 'lib/rbeapi/eapilib.rb', line 101

def connection_type
  @connection_type
end