CMakeLua/Utilities/cmcurl-7.19.0/lib/README.curlx

   1 $Id: README.curlx,v 1.1.1.1 2008-09-23 16:32:05 hoffman Exp $
   2                                   _   _ ____  _
   3                               ___| | | |  _ \| |
   4                              / __| | | | |_) | |
   5                             | (__| |_| |  _ <| |___
   6                              \___|\___/|_| \_\_____|
   7
   8                      Source Code Functions Apps Might Use
   9                      ====================================
  10
  11 The libcurl source code offers a few functions by source only. They are not
  12 part of the official libcurl API, but the source files might be useful for
  13 others so apps can optionally compile/build with these sources to gain
  14 additional functions.
  15
  16 We provide them through a single header file for easy access for apps:
  17 "curlx.h"
  18
  19  curlx_strtoofft()
  20
  21    A macro that converts a string containing a number to a curl_off_t number.
  22    This might use the curlx_strtoll() function which is provided as source
  23    code in strtoofft.c. Note that the function is only provided if no
  24    strtoll() (or equivalent) function exist on your platform. If curl_off_t
  25    is only a 32 bit number on your platform, this macro uses strtol().
  26
  27  curlx_tvnow()
  28
  29    returns a struct timeval for the current time.
  30
  31  curlx_tvdiff()
  32
  33    returns the difference between two timeval structs, in number of
  34    milliseconds.
  35
  36  curlx_tvdiff_secs()
  37
  38    returns the same as curlx_tvdiff but with full usec resolution (as a
  39    double)
  40
  41 FUTURE
  42 ======
  43
  44  Several functions will be removed from the public curl_ name space in a
  45  future libcurl release. They will then only become available as curlx_
  46  functions instead. To make the transition easier, we already today provide
  47  these functions with the curlx_ prefix to allow sources to get built properly
  48  with the new function names. The functions this concerns are:
  49
  50       curlx_getenv
  51       curlx_strequal
  52       curlx_strnequal
  53       curlx_mvsnprintf
  54       curlx_msnprintf
  55       curlx_maprintf
  56       curlx_mvaprintf
  57       curlx_msprintf
  58       curlx_mprintf
  59       curlx_mfprintf
  60       curlx_mvsprintf
  61       curlx_mvprintf
  62       curlx_mvfprintf