Skip to content

Commit 2ed0ff8

Browse files
committed
Add documentation for new options.
1 parent 94c6461 commit 2ed0ff8

File tree

1 file changed

+44
-34
lines changed

1 file changed

+44
-34
lines changed

libs/network/doc/reference/http_client.rst

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -168,40 +168,50 @@ initialization.
168168
Constructor taking a ``client_options<Tag>`` object. The following table
169169
shows the options you can set on a ``client_options<Tag>`` instance.
170170

171-
+---------------------+----------------------------+--------------------------+
172-
| Parameter Name | Type | Description |
173-
+=====================+============================+==========================+
174-
| follow_redirects | ``bool`` | Boolean to specify |
175-
| | | whether the client |
176-
| | | should follow HTTP |
177-
| | | redirects. Default is |
178-
| | | ``false``. |
179-
+---------------------+----------------------------+--------------------------+
180-
| cache_resolved | ``bool`` | Boolean to specify |
181-
| | | whether the client |
182-
| | | should cache resolved |
183-
| | | endpoints. The default |
184-
| | | is ``false``. |
185-
+---------------------+----------------------------+--------------------------+
186-
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
187-
| | | Boost.Asio |
188-
| | | ``io_service``. |
189-
+---------------------+----------------------------+--------------------------+
190-
| openssl_certificate | ``string`` | The filename of the |
191-
| | | certificate to load for |
192-
| | | the SSL connection for |
193-
| | | verification. |
194-
+---------------------+----------------------------+--------------------------+
195-
| openssl_verify_path | ``string`` | The directory from |
196-
| | | which the certificate |
197-
| | | authority files are |
198-
| | | located. |
199-
+---------------------+----------------------------+--------------------------+
200-
| always_verify_peer | ``bool`` | Boolean to specify |
201-
| | | whether the client |
202-
| | | should always verify |
203-
| | | peers in SSL connections |
204-
+---------------------+----------------------------+--------------------------+
171+
+--------------------------+----------------------------+--------------------------+
172+
| Parameter Name | Type | Description |
173+
+==========================+============================+==========================+
174+
| follow_redirects | ``bool`` | Boolean to specify |
175+
| | | whether the client |
176+
| | | should follow HTTP |
177+
| | | redirects. Default is |
178+
| | | ``false``. |
179+
+--------------------------+----------------------------+--------------------------+
180+
| cache_resolved | ``bool`` | Boolean to specify |
181+
| | | whether the client |
182+
| | | should cache resolved |
183+
| | | endpoints. The default |
184+
| | | is ``false``. |
185+
+--------------------------+----------------------------+--------------------------+
186+
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
187+
| | | Boost.Asio |
188+
| | | ``io_service``. |
189+
+--------------------------+----------------------------+--------------------------+
190+
| openssl_certificate | ``string`` | The filename of the |
191+
| | | certificate to load for |
192+
| | | the SSL connection for |
193+
| | | verification. |
194+
+--------------------------+----------------------------+--------------------------+
195+
| openssl_verify_path | ``string`` | The directory from |
196+
| | | which the certificate |
197+
| | | authority files are |
198+
| | | located. |
199+
+--------------------------+----------------------------+--------------------------+
200+
| always_verify_peer | ``bool`` | Boolean to specify |
201+
| | | whether the client |
202+
| | | should always verify |
203+
| | | peers in SSL connections |
204+
+--------------------------+----------------------------+--------------------------+
205+
| openssl_certificate_file | ``string`` | Filename of the |
206+
| | | certificate to use for |
207+
| | | client-side SSL session |
208+
| | | establishment. |
209+
+--------------------------+----------------------------+--------------------------+
210+
| openssl_private_key_file | ``string`` | Filename of the |
211+
| | | private key to use for |
212+
| | | client-side SSL session |
213+
| | | establishment. |
214+
+--------------------------+----------------------------+--------------------------+
205215

206216

207217
To use the above supported named parameters, you'll have code that looks like

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy