General Description of HTTP Clients.

deanberris · deanberris · commit e7b7d2a10681 · 2010-11-10T15:34:31.000+08:00
diff --git a/libs/network/doc/reference_http_client.rst b/libs/network/doc/reference_http_client.rst
@@ -5,7 +5,22 @@ HTTP Client API
 General
 -------
 
-.. FIXME describe the general API for the HTTP Clients
+:mod:`cpp-netlib` includes and implements a number of HTTP clients that you can
+use and embed in your own applications. All of the HTTP client implementations:
+
+* Cannot be copied. This means you may have to store instances of the clients in
+  dynamic memory.
+* Assume that requests made are independent of each other. There currently is no
+  cookie or session management system built-in to cpp-netlib's HTTP client
+  implementations.
+* Are header-only and are compiled-into your application. Future releases in
+  case you want to upgrade the implementation you are using in your application
+  will be distributed as header-only implementations, which means you have to
+  re-compile your application to use a newer version of the implementations.
+
+The HTTP clients all share the same API, but the internals are documented in
+terms of what is different and what to expect with the different
+implementations.
 
 Implementations
 ---------------
