diff options
author | Araq <rumpf_a@web.de> | 2020-11-13 17:16:00 +0100 |
---|---|---|
committer | Araq <rumpf_a@web.de> | 2020-11-13 17:16:00 +0100 |
commit | 02f8b11a716843be8270f8bf7b2dac94f1c7dc1a (patch) | |
tree | 8b7d523cf36451b36e0699d71d6d602608303199 | |
parent | 9f566881f15bed58276d3df4b5b2cb2289016396 (diff) | |
download | Nim-02f8b11a716843be8270f8bf7b2dac94f1c7dc1a.tar.gz |
fixes the doc rendering
-rw-r--r-- | lib/pure/asynchttpserver.nim | 73 |
1 files changed, 35 insertions, 38 deletions
diff --git a/lib/pure/asynchttpserver.nim b/lib/pure/asynchttpserver.nim index a5f6a0bc8..f3d4b3dd2 100644 --- a/lib/pure/asynchttpserver.nim +++ b/lib/pure/asynchttpserver.nim @@ -7,44 +7,41 @@ # distribution, for details about the copyright. # -##[ This module implements a high performance asynchronous HTTP server. - -This HTTP server has not been designed to be used in production, but -for testing applications locally. Because of this, when deploying your -application in production you should use a reverse proxy (for example nginx) -instead of allowing users to connect directly to this server. - -Basic usage -=========== - -This example will create an HTTP server on port 8080. The server will -respond to all requests with a ``200 OK`` response code and "Hello World" -as the response body. - -.. code-block::nim - import asynchttpserver, asyncdispatch - - proc main {.async.} = - var server = newAsyncHttpServer() - proc cb(req: Request) {.async.} = - #echo(req.reqMethod, " ", req.url) - #echo(req.headers) - let headers = {"Date": "Tue, 29 Apr 2014 23:40:08 GMT", - "Content-type": "text/plain; charset=utf-8"} - await req.respond(Http200, "Hello World", headers.newHttpHeaders()) - - server.listen Port(5555) - while true: - if server.shouldAcceptRequest(5): - var (address, client) = await server.socket.acceptAddr() - asyncCheck processClient(server, client, address, cb) - else: - poll() - - asyncCheck main() - runForever() - -]## +## This module implements a high performance asynchronous HTTP server. +## +## This HTTP server has not been designed to be used in production, but +## for testing applications locally. Because of this, when deploying your +## application in production you should use a reverse proxy (for example nginx) +## instead of allowing users to connect directly to this server. +## +## Basic usage +## =========== +## +## This example will create an HTTP server on port 8080. The server will +## respond to all requests with a ``200 OK`` response code and "Hello World" +## as the response body. +## +## .. code-block:: Nim +## +## import asynchttpserver, asyncdispatch +## +## proc main {.async.} = +## var server = newAsyncHttpServer() +## proc cb(req: Request) {.async.} = +## let headers = {"Date": "Tue, 29 Apr 2014 23:40:08 GMT", +## "Content-type": "text/plain; charset=utf-8"} +## await req.respond(Http200, "Hello World", headers.newHttpHeaders()) +## +## server.listen Port(5555) +## while true: +## if server.shouldAcceptRequest(5): +## var (address, client) = await server.socket.acceptAddr() +## asyncCheck processClient(server, client, address, cb) +## else: +## poll() +## +## asyncCheck main() +## runForever() import asyncnet, asyncdispatch, parseutils, uri, strutils import httpcore |