README.curlx 2.0 KB

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