Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

wpiutil: HttpServerConnection: add SendStaticResponse

Browse Source 
This function is intended for use when the content is a static const variable.
It allows gzipped static data, but doesn't provide the functionality to ungzip
it if the client doesn't support gzip.  This is because it would add a
dependency on zlib and basically all clients support gzip.

Change extraHeader on all Send functions to include the final newline,
this makes it easier to build up extra headers incrementally.

Expose sig::Connection for messageComplete and headerConn to allow them to
be disconnected by users of the class.  This is commonly needed for things
like WebSocket upgrades.
This commit is contained in:
Peter Johnson
2018-11-18 18:28:26 -08:00
parent d65547ea74
commit 0fb24538a7
2 changed files with 75 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
wpiutil/src/main/native/include/wpi/HttpServerConnection.h
View File

@@ -65,7 +65,7 @@ class HttpServerConnection {
* @param contentType MIME content type (e.g. "text/plain")
* @param contentLength Length of content. If 0 is provided, m_keepAlive will
* be set to false.
* @param extra Extra HTTP headers to send, not including final "\r\n"
* @param extra Extra HTTP headers to send, including final "\r\n"
*/
void BuildHeader(raw_ostream& os, int code, const Twine& codeText,
const Twine& contentType, uint64_t contentLength,
@@ -92,11 +92,29 @@ class HttpServerConnection {
* @param codeText HTTP response code text (e.g. "OK")
* @param contentType MIME content type (e.g. "text/plain")
* @param content Response message content
* @param extraHeader Extra HTTP headers to send, not including final "\r\n"
* @param extraHeader Extra HTTP headers to send, including final "\r\n"
*/
void SendResponse(int code, const Twine& codeText, const Twine& contentType,
StringRef content, const Twine& extraHeader = Twine{});
/**
* Send HTTP response from static data, along with other header information
* like mimetype. Calls BuildHeader(). Supports gzip pre-compressed data
* (it will decompress if the client does not accept gzip encoded data).
* Unlike SendResponse(), content is not copied and its contents must remain
* valid for an unspecified lifetime.
*
* @param code HTTP response code (e.g. 200)
* @param codeText HTTP response code text (e.g. "OK")
* @param contentType MIME content type (e.g. "text/plain")
* @param content Response message content
* @param gzipped True if content is gzip compressed
* @param extraHeader Extra HTTP headers to send, including final "\r\n"
*/
void SendStaticResponse(int code, const Twine& codeText,
const Twine& contentType, StringRef content,
bool gzipped, const Twine& extraHeader = Twine{});
/**
* Send error header and message.
* This provides standard code responses for 400, 401, 403, 404, 500, and 503.
@@ -114,8 +132,17 @@ class HttpServerConnection {
/** Whether the connection should be kept alive. */
bool m_keepAlive = false;
/** If gzip is an acceptable encoding for responses. */
bool m_acceptGzip = false;
/** The underlying stream for the connection. */
uv::Stream& m_stream;
/** The header reader connection. */
sig::Connection m_headerConn;
/** The message complete connection. */
sig::Connection m_messageCompleteConn;
};
} // namespace wpi