php-doc-en/reference/curl/functions/curl-getinfo.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/curl.xml, last change in rev 1.21 -->
  <refentry id='function.curl-getinfo'>
   <refnamediv>
    <refname>curl_getinfo</refname>
    <refpurpose>
     Get information regarding a specific transfer
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>curl_getinfo</methodname>
      <methodparam><type>resource</type><parameter>ch</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>opt</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns information about the last transfer, <parameter>opt</parameter> may be one of the following:
     <itemizedlist>
      <listitem>
       <simpara>
        "CURLINFO_EFFECTIVE_URL" - Last effective URL
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_HTTP_CODE" - Last received HTTP code
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_FILETIME" - Remote time of the retrieved document, if -1 is returned the time of the document is unknown
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_TOTAL_TIME" - Total transaction time in seconds for last transfer
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_NAMELOOKUP_TIME" - Time in seconds until name resolving was complete
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_CONNECT_TIME" - Time in seconds it took to establish the connection
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_PRETRANSFER_TIME" - Time in seconds from start until just before file transfer begins
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_STARTTRANSFER_TIME" - Time in seconds until the first byte is about to be transferred
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_REDIRECT_TIME" - Time in seconds of all redirection steps before final transaction was started
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_SIZE_UPLOAD" - Total number of bytes uploaded
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_SIZE_DOWNLOAD" - Total number of bytes downloaded
       </simpara>
      </listitem>      
      <listitem>
       <simpara>
        "CURLINFO_SPEED_DOWNLOAD" - Average download speed
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_SPEED_UPLOAD" - Average upload speed
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_HEADER_SIZE" - Total size of all headers received
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_REQUEST_SIZE" - Total size of issued requests, currently only for HTTP requests
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_SSL_VERIFYRESULT" - Result of SSL certification verification requested by setting CURLOPT_SSL_VERIFYPEER
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_CONTENT_LENGTH_DOWNLOAD" - content-length of download, read from Content-Length: field
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_CONTENT_LENGTH_UPLOAD" - Specified size of upload
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "CURLINFO_CONTENT_TYPE" - Content-type of downloaded object, NULL indicates server did not send valid Content-Type: header
       </simpara>
      </listitem>                                                                                                            
     </itemizedlist>
    </para>
    
    <para>
     If called without the optional parameter opt an associative array is returned with the following array elements which correspond to <parameter>opt</parameter> options:     
     <itemizedlist>
      <listitem>
       <simpara>
        "url"
       </simpara>       
      </listitem>
      <listitem>
       <simpara>
        "content_type"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "http_code"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "header_size"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "request_size"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "filetime"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "ssl_verify_result"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "redirect_count"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "total_time"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "namelookup_time"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "connect_time"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "pretransfer_time"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "size_upload"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "size_download"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "speed_download"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "speed_upload"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "download_content_length"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "upload_content_length"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "starttransfer_time"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        "redirect_time"
       </simpara>
      </listitem>                                       
     </itemizedlist>                    
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->