cpp-httplib/docs-src/pages/ja/cookbook/index.md at 9185fdb6ae4f7aaa3a78a3ec7289c606c7c5d951

mirror of https://github.com/yhirose/cpp-httplib.git synced 2026-09-02 14:53:46 +00:00

Files

yhirose 254e576b50 Add Server::CustomRoute() for HTTP methods outside the built-in set (#2553 )

* Add Server::CustomRoute() for HTTP methods outside the built-in set

parse_request_line validates the request method against a fixed whitelist and
rejects anything else with 400 before routing runs. That blocks WebDAV, where
PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK and UNLOCK are ordinary methods
defined by RFC 4918, and it blocks extension methods such as UPnP's SUBSCRIBE.
The need has been open since #847.

Registering a handler is now what makes the server accept a method:

    svr.CustomRoute("PROPFIND", "/dav/:id", handler);

Because custom methods go through the normal dispatch path, patterns work the
way they do for Get() and friends, and the request body is available in
req.body. Serving these methods through set_pre_routing_handler was never
enough: the body has not been read at that point, so PROPPATCH and LOCK, which
require one, could not be implemented at all.

A HandlerWithContentReader overload is available too. The content reader gate
in routing() also fires when a custom method carries no body, matching what
expect_content() does unconditionally for POST/PUT/PATCH/DELETE, so a body-less
PROPFIND (RFC 4918 treats one as allprop) reaches its handler instead of
falling through to 404.

Method names are validated as RFC 9110 tokens, and the ten built-in methods are
refused. Seven of them are dispatched by the if/else chain in routing() before
the custom tables are consulted, so a route registered for one could never
fire; CONNECT, TRACE and PRI carry protocol-level meaning this library does not
route. A refused registration makes is_valid() return false, so listen() fails
rather than starting a server holding a handler that would never run. This is
also why SSLServer::is_valid() now chains to Server::is_valid() instead of only
checking ctx_.

Servers that never call CustomRoute() keep the previous per-request cost: the
built-in method set is checked first and short-circuits, and the custom lookup
returns early on an empty map.

* Add cookbook recipe for custom HTTP methods

The CustomRoute() docs were a section inside S01, which pushed that page to 90
lines, the longest in the cookbook, and mixed a separate feature into a page
about registering GET/POST/PUT/DELETE handlers. Move the section into its own
recipe and give it room for the part that was missing: the OPTIONS handler
returning DAV: and Allow, which WebDAV clients probe for before anything else.
S01 goes back to 68 lines and keeps a pointer to the new page.

The recipe is titled after the API rather than after WebDAV, and says outright
that generating the 207 Multi-Status XML, interpreting Depth and managing locks
are the reader's job. Routing the method is all the library does.

S23 takes order 42, so the TLS, SSE and WebSocket recipes shift to 43-57. That
only moves the sort key. Filenames, the T01/E01/W01 labels, the published URLs
and every cross-reference are untouched.

2026-08-25 19:31:42 -04:00

4.6 KiB

Raw Blame History

title, order, status

title	order	status
Cookbook	0	draft

「〇〇をするには？」という問いに答えるレシピ集です。各レシピは独立しているので、必要なページだけ読めます。基本的な使い方はTourで紹介しています。

4.6 KiB

Raw Blame History

クライアント

基本

認証

ファイル送信

ストリーミング・進捗

接続・パフォーマンス

エラー処理・デバッグ

サーバー

基本

ストリーミング・ファイル

ハンドラチェーン

エラー処理・デバッグ

運用・チューニング

プロトコル拡張

TLS / セキュリティ

SSE

WebSocket

4.6 KiB Raw Blame History Unescape Escape

クライアント

基本

認証

ファイル送信

ストリーミング・進捗

接続・パフォーマンス

エラー処理・デバッグ

サーバー

基本

ストリーミング・ファイル

ハンドラチェーン

エラー処理・デバッグ

運用・チューニング

プロトコル拡張

TLS / セキュリティ

SSE

WebSocket

4.6 KiB

Raw Blame History