Module | Typhoeus::Response::Informations |
In: |
lib/typhoeus/response/informations.rb
|
This module contains logic about informations on a response.
Return the time, in seconds, it took from the start until the SSL/SSH connect/handshake to the remote host was completed. This time is most often very near to the pre transfer time, except for cases such as HTTP pipelining where the pretransfer time can be delayed due to waits in line for the pipeline and more.
@example Get appconnect_time.
response.appconnect_time
@return [ Float ] The appconnect_time.
Return the time, in seconds, it took from the start until the connect to the remote host (or proxy) was completed.
@example Get connect_time.
response.connect_time
@return [ Float ] The connect_time.
Return the last used effective url.
@example Get effective_url.
response.effective_url
@return [ String ] The effective_url.
Returns the response header.
@example Return headers.
response.headers
@return [ Typhoeus::Header ] The response header.
Return the available http auth methods. Bitmask indicating the authentication method(s) available.
@example Get httpauth_avail.
response.httpauth_avail
@return [ Integer ] The bitmask.
Return the time, in seconds, it took from the start until the name resolving was completed.
@example Get namelookup_time.
response.namelookup_time
@return [ Float ] The namelookup_time.
Return the time, in seconds, it took from the start until the file transfer is just about to begin. This includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. It does not involve the sending of the protocol- specific request that triggers a transfer.
@example Get pretransfer_time.
response.pretransfer_time
@return [ Float ] The pretransfer_time.
Return the string holding the IP address of the most recent connection done with this curl handle. This string may be IPv6 if that‘s enabled.
@example Get primary_ip.
response.primary_ip
@return [ String ] The primary_ip.
Return the total number of redirections that were actually followed
@example Get redirect_count.
response.redirect_count
@return [ Integer ] The redirect_count.
Return the time, in seconds, it took for all redirection steps include name lookup, connect, pretransfer and transfer before the final transaction was started. time_redirect shows the complete execution time for multiple redirections.
@example Get redirect_time.
response.redirect_time
@return [ Float ] The redirect_time.
Return all redirections in between as multiple responses with header.
@example Return redirections.
response.redirections
@return [ Array<Typhoeus::Response> ] The redirections
Return the http response body.
@example Get response_body.
response.response_body
@return [ String ] The response_body.
Return the last received HTTP, FTP or SMTP response code. The value will be zero if no server response code has been received. Note that a proxy‘s CONNECT response should be read with http_connect_code and not this.
@example Get response_code.
response.response_code
@return [ Integer ] The response_code.
Return the http response headers.
@example Get response_headers.
response.response_headers
@return [ String ] The response_headers.
Return libcurls return value.
@example Get return_code.
response.return_code
@return [ Symbol ] The return_code.
Returns a string describing the return.
@example Get return_message.
response.return_message
@return [ String ] The return_message.
@since 0.6.2
Return the time, in seconds, it took from the start until the first byte is received by libcurl. This includes pretransfer time and also the time the server needs to calculate the result.
@example Get starttransfer_time.
response.starttransfer_time
@return [ Float ] The starttransfer_time.
Return the total time in seconds for the previous transfer, including name resolving, TCP connect etc.
@example Get total_time.
response.total_time
@return [ Float ] The total_time.