Noir-async 1.1.0-beta7 API documentation

noir-async.core documentation

The main namespace to require when building an app with noir-async.

This should be the only method you need to send data.
All pushes to the client through this are asynchronous.
If it's a websocket this sends a message.
If it's a normal connection, it sends the entire response in one shot and closes the connection.
To start a multi-part connection, send a header with the the option :chunked set to true
  ex: (async-push conn {:chunked true})
If this is a multipart connection (a chunked header has been sent been called earlier) this sends a new body chunk.

Is this connection in chunked mode?

Closes the connection. No more data can be sent / received after this

Returns true if the connection is already closed

Creates an asynchronous noir route. This route can handle both
regular HTTP and Websocket connections. For regular HTTP
responses can be delivered in one shot, or in chunked mode.

Sets a callback to handle a closed connection. Callback takes no arguments.

Sets a callback to handle websocket messages.
Callback takes one argument, a string containing the message.

true if the connection is able to send a oneshot response, I.E. not chunked or a websocket.

Returns the connection's readable channel. Useful if you need to directly pipe using lamina.

true if this is a regular HTTP connection, I.E. not a websocket.

Retrieves the request body as a ByteBuffer

Retrieves the request body as a string.

True if the connection was is a websocket

Returns the connection's writable channel. Useful if you need to directly pipe using lamina.