Skip to content

Commit

Permalink
fixes the doc rendering
Browse files Browse the repository at this point in the history
  • Loading branch information
Araq committed Nov 13, 2020
1 parent 9f56688 commit 02f8b11
Showing 1 changed file with 35 additions and 38 deletions.
73 changes: 35 additions & 38 deletions lib/pure/asynchttpserver.nim
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 02f8b11

Please sign in to comment.