Exception: Lightstreamer::LightstreamerError

Inherits:

StandardError

• Object
• StandardError
• Lightstreamer::LightstreamerError

Defined in:

lib/lightstreamer/errors.rb,
lib/lightstreamer/errors.rb

Overview

Base class for all errors raised by this gem.

Direct Known Subclasses

Errors::AuthenticationError, Errors::ClientVersionNotSupportedError, Errors::ConfiguredMaximumServerLoadReachedError, Errors::ConfiguredMaximumSessionsReachedError, Errors::ConnectionError, Errors::IllegalMessageError, Errors::IncompatibleSessionError, Errors::InvalidDataAdapterError, Errors::InvalidFieldError, Errors::InvalidItemError, Errors::InvalidItemForFieldsError, Errors::InvalidProgressiveNumberError, Errors::InvalidSelectorError, Errors::LicensedMaximumSessionsReachedError, Errors::MessageElaborationFailedError, Errors::MessagesSkippedByTimeoutError, Errors::MetadataAdapterError, Errors::NewSessionsTemporarilyBlockedError, Errors::RawModeNotAllowedByLicenseError, Errors::SessionEndError, Errors::StreamingNotAvailableError, Errors::SubscriptionsNotAllowedByLicenseError, Errors::SyncError, Errors::TableModificationNotAllowedError, Errors::UnfilteredDispatchingNotAllowedByLicenseError, Errors::UnfilteredDispatchingNotAllowedForItemError, Errors::UnfilteredDispatchingNotSupportedForItemError, Errors::UnknownAdapterSetError, Errors::UnknownTableError, Errors::UnsupportedModeForItemError

Class Method Summary

• .build(message, code) ⇒ LightstreamerError

  Takes a Lightstreamer error message and numeric code and returns an instance of the relevant error class that should be raised in response to the error.

Class Method Details

.build(message, code) ⇒ LightstreamerError

Takes a Lightstreamer error message and numeric code and returns an instance of the relevant error class that should be raised in response to the error.

Parameters:

• message (String) —

  The error message.

• code (Fixnum) —

  The numeric error code that is used to determine which Lightstreamer::LightstreamerError subclass to instantiate.

Returns:

• (LightstreamerError)

# File 'lib/lightstreamer/errors.rb', line 188

def self.build(message, code)
  code = code.to_i

  if API_ERROR_CODE_TO_CLASS.key? code
    API_ERROR_CODE_TO_CLASS[code].new ''
  elsif code <= 0
    Errors::MetadataAdapterError.new message, code
  else
    new "#{code}: #{message}"
  end
end