jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

better documentation

Browse source
This commit is contained in:
Araq 2020-11-13 13:07:48 +01:00
commit cb19dc53ca
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lib/pure/asynchttpserver.nim
View file

@ -293,7 +293,7 @@ proc processRequest(
request.client.close() request.client.close()
return false return false
proc processClient*(server: AsyncHttpServer, client: AsyncSocket, address: string, proc processClient(server: AsyncHttpServer, client: AsyncSocket, address: string,
callback: proc (request: Request): callback: proc (request: Request):
Future[void] {.closure, gcsafe.}) {.async.} = Future[void] {.closure, gcsafe.}) {.async.} =
var request = newFutureVar[Request]("asynchttpserver.processClient") var request = newFutureVar[Request]("asynchttpserver.processClient")
@ -309,6 +309,7 @@ proc processClient*(server: AsyncHttpServer, client: AsyncSocket, address: strin
if not retry: break if not retry: break
proc listen*(server: AsyncHttpServer; port: Port; address = "") = proc listen*(server: AsyncHttpServer; port: Port; address = "") =
## Listen to the given port and address.
server.maxFDs = maxDescriptors() server.maxFDs = maxDescriptors()
server.socket = newAsyncSocket() server.socket = newAsyncSocket()
if server.reuseAddr: if server.reuseAddr:
@ -328,7 +329,8 @@ proc shouldAcceptRequest*(server: AsyncHttpServer;
proc acceptRequest*(server: AsyncHttpServer, port: Port, proc acceptRequest*(server: AsyncHttpServer, port: Port,
callback: proc (request: Request): Future[void] {.closure, gcsafe.}) {.async.} = callback: proc (request: Request): Future[void] {.closure, gcsafe.}) {.async.} =
## Accepts a single request. ## Accepts a single request. Write an explicit loop around this proc so that
## errors can be handled properly.
var (address, client) = await server.socket.acceptAddr() var (address, client) = await server.socket.acceptAddr()
asyncCheck processClient(server, client, address, callback) asyncCheck processClient(server, client, address, callback)
@ -341,8 +343,13 @@ proc serve*(server: AsyncHttpServer, port: Port,
## ##
## When a request is made by a client the specified callback will be called. ## When a request is made by a client the specified callback will be called.
## ##
## If `flowControl` is true the server cares about the process's maximum ## If `assumedDescriptorsPerRequest` is 0 or greater the server cares about
## file descriptor limit. ## the process's maximum file descriptor limit. It then ensures that the
## process still has the resources for `assumedDescriptorsPerRequest`
## file descriptors before accepting a connection.
##
## You should prefer to call `acceptRequest` instead with a custom server
## loop so that you're in control over the error handling and logging.
listen server, port, address listen server, port, address
while true: while true:
if shouldAcceptRequest(server, assumedDescriptorsPerRequest): if shouldAcceptRequest(server, assumedDescriptorsPerRequest):