Function sendFile
Sends a file to the given HTTP server response object.
When serving a file, certain request headers are supported to avoid sending
the file if the client has it already cached. These headers are
"If-Modified-Since"
and "If-None-Match"
. The client will be delivered
with the necessary "Etag"
(generated from the path
, size and last
modification time of the file) and "Last-Modified"
headers.
The cache control directives "Expires"
and "Cache-Control"
will also be
emitted if the HTTPFileServerSettings
field is set to a positive
duration.
Finally, HEAD requests will automatically be handled without reading the actual file contents. Am empty response body is written instead.
Prototype
void sendFile(
scope HTTPServerRequest req,
scope HTTPServerResponse res,
Path path,
HTTPFileServerSettings settings = null
);
Parameters
Name | Description |
---|---|
req | The incoming HTTP request - cache and modification headers of the request can influence the generated response. |
res | The response object to write to. |
settings | Optional settings object enabling customization of how the
file gets served. |
Authors
Sönke Ludwig
Copyright
© 2012-2015 RejectedSoftware e.K.
License
Subject to the terms of the MIT license, as written in the included LICENSE.txt file.