GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — libhttpserver/src/httpserver/hook_phase.hpp at master · jlmartinnc/libhttpserver

Expand file tree

/

hook_phase.hpp

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
111 lines (100 loc) · 3.81 KB
/

hook_phase.hpp

Copy path

File metadata and controls

111 lines (100 loc) · 3.81 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
This file is part of libhttpserver
Copyright (C) 2011-2026 Sebastiano Merlino
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
*/
#if !defined (_HTTPSERVER_HPP_INSIDE_) && !defined (HTTPSERVER_COMPILATION)
#error "Only <httpserver.hpp> or <httpserverpp> can be included directly."
#endif
#ifndef SRC_HTTPSERVER_HOOK_PHASE_HPP_
#define SRC_HTTPSERVER_HOOK_PHASE_HPP_
#include <cstddef>
#include <cstdint>
#include <string_view>
/**
* @file hook_phase.hpp
* @brief Enumerates the eleven lifecycle phases at which user hooks fire.
*
* Storage and firing
* semantics live in detail/webserver_impl.hpp; per-phase callable
* signatures live in hook_context.hpp and the matching
* webserver::add_hook / http_resource::add_hook overloads.
*/
namespace httpserver {
/**
* @brief Enumerates the eleven points along the request / response
* lifecycle at which user-registered hooks may fire.
*
* Phases are listed in firing order. `count_` is a sentinel and must
* remain last; it is not a valid phase value. The underlying type is
* `std::uint8_t` -- two orders of magnitude of growth headroom past
* the current eleven phases.
*
* Five phases (`before_handler`, `handler_exception`, `after_handler`,
* `response_sent`, `request_completed`) are also valid arguments to
* `http_resource::add_hook` for per-route registration. The other six
* are server-wide only.
*/
enum class hook_phase : std::uint8_t {
connection_opened,
accept_decision,
request_received,
body_chunk,
route_resolved,
before_handler,
handler_exception,
after_handler,
response_sent,
request_completed,
connection_closed,
count_ // sentinel; must remain last
};
static_assert(static_cast<std::size_t>(hook_phase::count_) == 11u,
"hook_phase::count_ must be 11");
/**
* @brief Spec-canonical name of a phase, for error messages and logs.
*
* Total over the eleven declared enumerators; any other underlying
* value (only producible via `static_cast`) returns an empty view
* rather than crashing. Used by the wrong-phase `add_hook` throw site
* and by hook telemetry / docs.
*
* @param p phase to name.
* @return canonical name as a `std::string_view`, or an empty view if
* `p` is `count_` or an out-of-range underlying value.
*/
constexpr std::string_view to_string(hook_phase p) noexcept {
// Names indexed by the hook_phase underlying value. Keep this array
// in lockstep with the enum declaration above. A constexpr lookup
// beats a 12-case switch on the CCN gate and codegens to the same
// jump table on a modern optimiser.
constexpr std::string_view kNames[] = {
"connection_opened",
"accept_decision",
"request_received",
"body_chunk",
"route_resolved",
"before_handler",
"handler_exception",
"after_handler",
"response_sent",
"request_completed",
"connection_closed",
};
const auto idx = static_cast<std::size_t>(p);
if (idx >= sizeof(kNames) / sizeof(kNames[0])) return {};
return kNames[idx];
}
} // namespace httpserver
#endif // SRC_HTTPSERVER_HOOK_PHASE_HPP_
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.