class Net::SFTP::Response
Encapsulates a response from the remote server, to a specific client request. Response
objects are passed as parameters to callbacks when you are performing asynchronous operations; when you call Net::SFTP::Request#wait
, you can get the corresponding response object via Net::SFTP::Request#response
.
sftp.open("/path/to/file") do |response| p response.ok? p response[:handle] end sftp.loop
Constants
- MAP
Attributes
The numeric code, one of the FX_* constants
A hash of request-specific data, such as a file handle or attribute information
The textual message for this response (possibly blank)
The request object that this object is in response to
Public Instance Methods
Source
# File lib/net/sftp/response.rb, line 41 def [](key) data[key.to_sym] end
Retrieve the data item with the given key
. The key is converted to a symbol before being used to lookup the value.
Source
# File lib/net/sftp/response.rb, line 63 def eof? code == FX_EOF end
Returns true
if the status code is FX_EOF; false
otherwise.
Source
# File lib/net/sftp/response.rb, line 58 def ok? code == FX_OK end
Returns true
if the status code is FX_OK; false
otherwise.
Source
# File lib/net/sftp/response.rb, line 47 def to_s if message && !message.empty? && message.downcase != MAP[code] "#{message} (#{MAP[code]}, #{code})" else "#{MAP[code]} (#{code})" end end
Returns a textual description of this response, including the status code and name.