aboutsummaryrefslogtreecommitdiff
path: root/lib/README.curlx
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-04-07 07:30:40 +0000
committerDaniel Stenberg <daniel@haxx.se>2004-04-07 07:30:40 +0000
commitcf1f46e1ca001dcab81e9116712c3eefefc03fd7 (patch)
tree1e80b81b7bf5203a2a7ca818e3d17fcb93bca50c /lib/README.curlx
parentf052cbee1999a9dce6954efd466fd16c223c16a7 (diff)
renamed the strtoofft() macro to curlx_strtoofft() to adjust to the curlx_*
concept, and added lib/README.curlx to explain details about it
Diffstat (limited to 'lib/README.curlx')
-rw-r--r--lib/README.curlx43
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/README.curlx b/lib/README.curlx
new file mode 100644
index 000000000..663aea375
--- /dev/null
+++ b/lib/README.curlx
@@ -0,0 +1,43 @@
+$Id$
+ _ _ ____ _
+ ___| | | | _ \| |
+ / __| | | | |_) | |
+ | (__| |_| | _ <| |___
+ \___|\___/|_| \_\_____|
+
+ Source Code Functions Apps Might Use
+ ====================================
+
+The libcurl source code offers a few functions by source only. They are not
+part of the official libcurl API, but the source files might be useful for
+others so apps can optionally compile/build with these sources to gain
+additional functions.
+
+
+strtoofft.[ch]
+==============
+
+ curlx_strtoofft()
+
+ A macro that converts a string containing a number to a curl_off_t number.
+ This might use the curlx_strtoll() function which is provided as source
+ code in strtoofft.c. Note that the function is only provided if no
+ strtoll() (or equivalent) function exist on your platform. If curl_off_t
+ is only a 32 bit number on your platform, this macro uses strtol().
+
+timeval.[ch]
+============
+
+ Provides a 'struct timeval' for platforms that don't have one already, and
+ includes the proper include files for those that have one. Using this will
+ make the output require the 'winmm' lib on Windows (unless WITHOUT_MM_LIB
+ is defined at compile-time).
+
+ curlx_tvnow()
+
+ returns a struct timeval for the current time.
+
+ curlx_tvdiff()
+
+ returns the difference between two timeval structs, in number of
+ milliseconds.