mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-04 12:07:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add client.close() in httpclient examples. (#20118)

Browse Source 
Without this, the httpclient examples are essentially setting you up for failure. I was bitten by this when my app became unable to open any more sockets.

I'm not entirely sure how long this will relevant, as I hope destructors will be added to an upcoming version of the stdlib. But figured it was worth submitting anyways!
This commit is contained in:
gecko
2022-08-04 05:46:08 +01:00
committed by GitHub
parent 09840c09e4
commit 7af484da94
1 changed files with 25 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
lib/pure/httpclient.nim
View File

@@ -19,7 +19,10 @@
## .. code-block:: Nim
## import std/httpclient
## var client = newHttpClient()
## echo client.getContent("http://google.com")
## try:
## echo client.getContent("http://google.com")
## finally:
## client.close()
##
## The same action can also be performed asynchronously, simply use the
## `AsyncHttpClient`:
@@ -29,7 +32,10 @@
##
## proc asyncProc(): Future[string] {.async.} =
## var client = newAsyncHttpClient()
## return await client.getContent("http://example.com")
## try:
## return await client.getContent("http://example.com")
## finally:
## client.close()
##
## echo waitFor asyncProc()
##
@@ -53,8 +59,10 @@
## data["output"] = "soap12"
## data["uploaded_file"] = ("test.html", "text/html",
## "<html><head></head><body><p>test</p></body></html>")
##
## echo client.postContent("http://validator.w3.org/check", multipart=data)
## try:
## echo client.postContent("http://validator.w3.org/check", multipart=data)
## finally:
## client.close()
##
## To stream files from disk when performing the request, use `addFiles`.
##
@@ -66,8 +74,10 @@
## var client = newHttpClient()
## var data = newMultipartData()
## data.addFiles({"uploaded_file": "test.html"}, mimeDb = mimes)
##
## echo client.postContent("http://validator.w3.org/check", multipart=data)
## try:
## echo client.postContent("http://validator.w3.org/check", multipart=data)
## finally:
## client.close()
##
## You can also make post requests with custom headers.
## This example sets `Content-Type` to `application/json`
@@ -81,8 +91,11 @@
## let body = %*{
## "data": "some text"
## }
## let response = client.request("http://some.api", httpMethod = HttpPost, body = $body)
## echo response.status
## try:
## let response = client.request("http://some.api", httpMethod = HttpPost, body = $body)
## echo response.status
## finally:
## client.close()
##
## Progress reporting
## ==================
@@ -101,7 +114,10 @@
## proc asyncProc() {.async.} =
## var client = newAsyncHttpClient()
## client.onProgressChanged = onProgressChanged
## discard await client.getContent("http://speedtest-ams2.digitalocean.com/100mb.test")
## try:
## discard await client.getContent("http://speedtest-ams2.digitalocean.com/100mb.test")
## finally:
## client.close()
##
## waitFor asyncProc()
##