Skip to content

Commit ac0f787

Browse files
committed
Fleshing out Synchronous Clients section of the HTTP Client API Reference Manual.
1 parent 3f9c189 commit ac0f787

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

libs/network/doc/reference_http_client.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,21 @@ the HTTP client implementation provided by :mod:`cpp-netlib`.
4949
Synchronous Clients
5050
~~~~~~~~~~~~~~~~~~~
5151

52-
.. FIXME show the table of tags that enable the synchronous implementation.
52+
Of the client tags shown in the table, the following makes the ``basic_client``
53+
behave as a fully synchonous client.
54+
55+
* **http_default_8bit_tcp_resolve**
56+
* **http_default_8bit_udp_resolve**
57+
* **http_keepalive_8bit_tcp_resolve**
58+
* **http_keepalive_8bit_udp_resolve**
59+
60+
The synchronous client implements all the operations of the client underneath
61+
the interface all block to wait for I/O to finish. All the member methods are
62+
synchronous and will block until the response object is ready or throws if erros
63+
are encountered in the performance of the HTTP requests.
64+
65+
.. warning:: The synchronous clients are **NOT** thread safe. You will need to do
66+
external synchronization to use synchronous client implementations.
5367

5468
Asynchronous Clients
5569
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)