Migrate to libmicrohttpd 1.0.0 API with new features#370
Open
Migrate to libmicrohttpd 1.0.0 API with new features#370
Conversation
Raise minimum libmicrohttpd requirement to 1.0.0 and migrate all deprecated APIs to their v3 replacements: - Basic Auth: MHD_basic_auth_get_username_password3, MHD_queue_basic_auth_required_response3 with UTF-8 support - Digest Auth: MHD_digest_auth_check3, MHD_digest_auth_check_digest3, MHD_queue_auth_required_response3 with SHA-512/256, userhash, nonce binding, and structured digest_auth_result enum Add new response types: empty_response, pipe_response, iovec_response. Add external event loop integration (run, run_wait, get_fdset, get_timeout, add_connection), daemon management (quiesce, get_listen_fd, get_active_connections, get_bound_port), and numerous new daemon options (listen_backlog, address_reuse, tcp_fastopen_queue_size, turbo, etc.). Add conditional WebSocket support via libmicrohttpd_ws. Add utility functions: reason_phrase, is_feature_supported, get_mhd_version.
Document WebSocket support, new response types (empty, iovec, pipe), external event loop integration, daemon introspection methods, new server configuration options (turbo, no_listen_socket, suppress_date_header, etc.), enhanced TLS options, updated digest authentication API with SHA-256/SHA-512/256 and fine-grained result codes, and new http_utils utility methods.
New example files: - empty_response_example: 204 No Content and HEAD-only responses - iovec_response_example: scatter-gather response from multiple buffers - pipe_response_example: streaming response from a pipe fd - websocket_echo: WebSocket echo server with on_open/on_message/on_close - daemon_info: daemon introspection (bound port, listen fd, http_utils) - external_event_loop: driving the server with run_wait() and quiesce() - turbo_mode: high-performance config with turbo, suppressed date header, TCP Fast Open, and listen backlog All examples are added to the Other Examples section of the README with inline code, test commands, and links to the source files.
The existing string_response already supports binary content (std::string can hold arbitrary bytes), but this was not documented or demonstrated anywhere. This gap caused users to believe a new response type was needed (see PR #368). - Add a note to the README's string_response description clarifying binary data support - Add a new "Serving binary data from memory" section with inline example - Add examples/binary_buffer_response.cpp as a complete, buildable example that serves a PNG image from an in-memory buffer - Register the new example in examples/Makefile.am https://un5nfbgrg35vjq0.julianrbryant.com/code/session_01S3BvBrSoNvUhpYTyhPYCjJ
Add ChangeLog entry for the binary buffer example to satisfy the ChangeLog Check workflow. Add missing #include <utility> for std::move to fix cpplint warning. https://un5nfbgrg35vjq0.julianrbryant.com/code/session_01S3BvBrSoNvUhpYTyhPYCjJ
Raise minimum libmicrohttpd requirement to 1.0.0 and migrate all deprecated APIs to their v3 replacements: - Basic Auth: MHD_basic_auth_get_username_password3, MHD_queue_basic_auth_required_response3 with UTF-8 support - Digest Auth: MHD_digest_auth_check3, MHD_digest_auth_check_digest3, MHD_queue_auth_required_response3 with SHA-512/256, userhash, nonce binding, and structured digest_auth_result enum Add new response types: empty_response, pipe_response, iovec_response. Add external event loop integration (run, run_wait, get_fdset, get_timeout, add_connection), daemon management (quiesce, get_listen_fd, get_active_connections, get_bound_port), and numerous new daemon options (listen_backlog, address_reuse, tcp_fastopen_queue_size, turbo, etc.). Add conditional WebSocket support via libmicrohttpd_ws. Add utility functions: reason_phrase, is_feature_supported, get_mhd_version.
Replace strlen(s) with std::char_traits<char>::length(s) in unescaper_func to silence Codacy static analysis warning about potential over-read on non-null-terminated strings. The MHD API guarantees s is null-terminated, but using the C++ equivalent avoids false positives from C-focused analyzers.
Resolve conflicts in ChangeLog (entry ordering), README.md (response type count reflects new types), and examples/Makefile.am (keep new example programs alongside binary_buffer_response from master).
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #370 +/- ##
==========================================
+ Coverage 67.97% 68.03% +0.06%
==========================================
Files 28 34 +6
Lines 1636 1730 +94
Branches 672 697 +25
==========================================
+ Hits 1112 1177 +65
- Misses 64 80 +16
- Partials 460 473 +13
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
digest_auth_resultenum)empty_response,pipe_response,iovec_responserun(),run_wait(),get_fdset(),get_timeout(),add_connection()quiesce(),get_listen_fd(),get_active_connections(),get_bound_port()listen_backlog,address_reuse,connection_memory_increment,tcp_fastopen_queue_size,sigpipe_handled_by_app,https_mem_dhparams,https_key_password,https_priorities_append,no_alpn,client_discipline_levelno_listen_socket,no_thread_safety,turbo,suppress_date_headerlibmicrohttpd_ws(websocket_handler,websocket_session,register_ws_resource())reason_phrase(),is_feature_supported(),get_mhd_version()Breaking changes
check_digest_auth()now returnsdigest_auth_resultenum instead ofbool+reload_nonceout-paramcheck_digest_auth_ha1()renamed tocheck_digest_auth_digest()to match MHD v3 namingdigest_auth_fail_responseconstructor parameter order changed;reload_noncerenamed tosignal_staleTest plan
daemon_infointegration test for daemon management methodsnew_response_typesintegration test for empty/pipe/iovec responsesmake checkwith libmicrohttpd >= 1.0.0libmicrohttpd_ws)