Exception: TCPClient::TimeoutError

Inherits:

NetworkError

• Object
• StandardError
• NetworkError
• TCPClient::TimeoutError

Defined in:

lib/tcp-client/errors.rb

Overview

Base exception class for a detected timeout.

You should catch this exception class when you like to handle any timeout error.

Direct Known Subclasses

ConnectTimeoutError, ReadTimeoutError, WriteTimeoutError

Instance Attribute Summary

• #action ⇒ Symbol readonly

  The action which timed out.

Instance Method Summary

• #initialize(message = nil) ⇒ TimeoutError constructor

  Initializes the instance with an optional message.

Constructor Details

#initialize ⇒ TimeoutError #initialize(message) ⇒ TimeoutError

Initializes the instance with an optional message.

The message will be generated from #action when not specified.

Parameters:

• message (#to_s) (defaults to: nil) —

  the error message

# File 'lib/tcp-client/errors.rb', line 89

def initialize(message = nil)
  super(message || "unable to #{action} in time")
end

Instance Attribute Details

#action ⇒ Symbol (readonly)

Returns the action which timed out.

Returns:

• (Symbol) —

  the action which timed out

# File 'lib/tcp-client/errors.rb', line 97

def action = :process