summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorPhilippMDoerner <philippmdoerner@web.de>2023-01-18 19:10:05 +0100
committerGitHub <noreply@github.com>2023-01-18 13:10:05 -0500
commitfd207827c5929ba5eb244dd2442457944a55b7d0 (patch)
treed231ccecd98fa0dd9a2601fa6ad890592a5b1a82 /lib
parentfc35f83eee55610af3931f95771b6d1bce1fc845 (diff)
downloadNim-fd207827c5929ba5eb244dd2442457944a55b7d0.tar.gz
Add docs informing about gotcha of clients (#21262)
* Add docs informing about gotcha of clients

It is a hidden problem that AsyncHttpClient-instances *can not* deal with multiple requests at once.
Similar to normal HttpClients they can only deal with sending one request at a time.
This is not told anywhere in the documentation, but critical information that should be available to the user.

* Update lib/pure/httpclient.nim

fixes typo

Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>

Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/httpclient.nim4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/pure/httpclient.nim b/lib/pure/httpclient.nim
index c832d4285..d2cf64149 100644
--- a/lib/pure/httpclient.nim
+++ b/lib/pure/httpclient.nim
@@ -46,6 +46,10 @@
 ## **Note:** You need to run asynchronous examples in an async proc
 ## otherwise you will get an `Undeclared identifier: 'await'` error.
 ##
+## **Note:** An asynchronous client instance can only deal with one
+## request at a time. To send multiple requests in parallel, use
+## multiple client instances.
+##
 ## Using HTTP POST
 ## ===============
 ##