The Req object also allows you to send a response.
You can only send one response. Any other attempt will trigger a crash. The response may be sent in one go or with its body streamed by chunks of arbitrary size.
You can also set headers or the response body in advance and Cowboy will use them when you finally do reply.
You can send a reply with no particular headers or body. Cowboy will make sure to send the mandatory headers with the response.
You can define headers to be sent with the response. Note that header names must be lowercase. Again, Cowboy will make sure to send the mandatory headers with the response.
You can override headers that Cowboy would send otherwise. Any header set by the user will be used over the ones set by Cowboy. For example, you can advertise yourself as a different server.
We also saw earlier how to force close the connection by overriding the connection header.
Finally, you can also send a body with the response. Cowboy will automatically set the content-length header if you do. We recommend that you set the content-type header so the client may know how to read the body.
Here is the same example but sending HTML this time.
Note that the reply is sent immediately.
You can also stream the response body. First, you need to initiate the reply by sending the response status code. Then you can send the body in chunks of arbitrary size.
You should make sure to match on
ok as an error may be returned.
While it is possible to send a chunked response without a content-type header, it is still recommended. You can set this header or any other just like for normal replies.
Note that the reply and each chunk following it are sent immediately.
You can define response headers in advance. They will be merged into the headers given in the reply call. Headers in the reply call override preset response headers which override the default Cowboy headers.
You can check if a response header has already been set. This will only check the response headers that you set, and not the ones Cowboy will add when actually sending the reply.
It will return
true if the header is defined, and
Finally, you can also delete a preset response header if needed. If you do, it will not be sent.
You can set the response body in advance. Note that this body will be ignored if you then choose to send a chunked reply, or if you send a reply with an explicit body.
You can also set a fun that will be called when it is time to send the body. There are three different ways of doing that.
If you know the length of the body that needs to be sent, you should specify it, as it will help clients determine the remaining download time and allow them to inform the user.
If you do not know the length of the body, you should use a chunked response body fun instead.
Finally, you can also send data on the socket directly, without knowing the length in advance. Cowboy may be forced to close the connection at the end of the response though depending on the protocol capabilities.
You can send files directly from disk without having to read them. Cowboy will use the
sendfile syscall when possible, which means that the file is sent to the socket directly from the kernel, which is a lot more performant than doing it from userland.
Again, it is recommended to set the size of the file if it can be known in advance.
Please see the Ranch guide for more information about sending files.