![]() |
Bitcoin Core
21.99.0
P2P Digital Currency
|
#include <httpserver.h>
#include <chainparamsbase.h>
#include <compat.h>
#include <netbase.h>
#include <node/ui_interface.h>
#include <rpc/protocol.h>
#include <shutdown.h>
#include <sync.h>
#include <util/strencodings.h>
#include <util/system.h>
#include <util/threadnames.h>
#include <util/translation.h>
#include <deque>
#include <memory>
#include <stdio.h>
#include <stdlib.h>
#include <string>
#include <sys/types.h>
#include <sys/stat.h>
#include <event2/thread.h>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#include <event2/util.h>
#include <event2/keyvalq_struct.h>
#include <support/events.h>
Go to the source code of this file.
Classes | |
class | HTTPWorkItem |
HTTP request work item. More... | |
class | WorkQueue< WorkItem > |
Simple work queue for distributing work over multiple threads. More... | |
struct | HTTPPathHandler |
Macros | |
#define | EVENT_LOG_WARN _EVENT_LOG_WARN |
Functions | |
static bool | ClientAllowed (const CNetAddr &netaddr) |
Check if a network address is allowed to access the HTTP server. More... | |
static bool | InitHTTPAllowList () |
Initialize ACL list for HTTP server. More... | |
std::string | RequestMethodString (HTTPRequest::RequestMethod m) |
HTTP request method as string - use for logging only. More... | |
static void | http_request_cb (struct evhttp_request *req, void *arg) |
HTTP request callback. More... | |
static void | http_reject_request_cb (struct evhttp_request *req, void *) |
Callback to reject HTTP requests after shutdown. More... | |
static bool | ThreadHTTP (struct event_base *base) |
Event dispatcher thread. More... | |
static bool | HTTPBindAddresses (struct evhttp *http) |
Bind HTTP server to specified addresses. More... | |
static void | HTTPWorkQueueRun (WorkQueue< HTTPClosure > *queue, int worker_num) |
Simple wrapper to set thread name and run work queue. More... | |
static void | libevent_log_cb (int severity, const char *msg) |
libevent event log callback More... | |
bool | InitHTTPServer () |
Initialize HTTP server. More... | |
bool | UpdateHTTPServerLogging (bool enable) |
Change logging level for libevent. More... | |
void | StartHTTPServer () |
Start HTTP server. More... | |
void | InterruptHTTPServer () |
Interrupt HTTP server threads. More... | |
void | StopHTTPServer () |
Stop HTTP server. More... | |
struct event_base * | EventBase () |
Return evhttp event base. More... | |
static void | httpevent_callback_fn (evutil_socket_t, short, void *data) |
void | RegisterHTTPHandler (const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler) |
Register handler for prefix. More... | |
void | UnregisterHTTPHandler (const std::string &prefix, bool exactMatch) |
Unregister handler for prefix. More... | |
Variables | |
static const size_t | MAX_HEADERS_SIZE = 8192 |
Maximum size of http request (request line + headers) More... | |
static struct event_base * | eventBase = nullptr |
HTTP module state. More... | |
static struct evhttp * | eventHTTP = nullptr |
HTTP server. More... | |
static std::vector< CSubNet > | rpc_allow_subnets |
List of subnets to allow RPC connections from. More... | |
static WorkQueue< HTTPClosure > * | workQueue = nullptr |
Work queue for handling longer requests off the event loop thread. More... | |
static std::vector< HTTPPathHandler > | pathHandlers |
Handlers for (sub)paths. More... | |
static std::vector< evhttp_bound_socket * > | boundSockets |
Bound listening sockets. More... | |
static std::thread | g_thread_http |
static std::vector< std::thread > | g_thread_http_workers |
#define EVENT_LOG_WARN _EVENT_LOG_WARN |
|
static |
Check if a network address is allowed to access the HTTP server.
Definition at line 147 of file httpserver.cpp.
struct event_base* EventBase | ( | ) |
Return evhttp event base.
This can be used by submodules to queue timers or custom events.
Definition at line 476 of file httpserver.cpp.
|
static |
Callback to reject HTTP requests after shutdown.
Definition at line 273 of file httpserver.cpp.
|
static |
HTTP request callback.
Definition at line 207 of file httpserver.cpp.
|
static |
Bind HTTP server to specified addresses.
Definition at line 291 of file httpserver.cpp.
|
static |
|
static |
Simple wrapper to set thread name and run work queue.
Definition at line 333 of file httpserver.cpp.
|
static |
Initialize ACL list for HTTP server.
Definition at line 158 of file httpserver.cpp.
bool InitHTTPServer | ( | ) |
Initialize HTTP server.
Call this before RegisterHTTPHandler or EventBase().
Definition at line 352 of file httpserver.cpp.
void InterruptHTTPServer | ( | ) |
Interrupt HTTP server threads.
Definition at line 432 of file httpserver.cpp.
|
static |
libevent event log callback
Definition at line 340 of file httpserver.cpp.
void RegisterHTTPHandler | ( | const std::string & | prefix, |
bool | exactMatch, | ||
const HTTPRequestHandler & | handler | ||
) |
Register handler for prefix.
If multiple handlers match a prefix, the first-registered one will be invoked.
Definition at line 634 of file httpserver.cpp.
std::string RequestMethodString | ( | HTTPRequest::RequestMethod | m | ) |
HTTP request method as string - use for logging only.
Definition at line 186 of file httpserver.cpp.
void StartHTTPServer | ( | ) |
Start HTTP server.
This is separate from InitHTTPServer to give users race-condition-free time to register their handlers between InitHTTPServer and StartHTTPServer.
Definition at line 420 of file httpserver.cpp.
void StopHTTPServer | ( | ) |
Stop HTTP server.
Definition at line 443 of file httpserver.cpp.
|
static |
Event dispatcher thread.
Definition at line 280 of file httpserver.cpp.
void UnregisterHTTPHandler | ( | const std::string & | prefix, |
bool | exactMatch | ||
) |
Unregister handler for prefix.
Definition at line 640 of file httpserver.cpp.
bool UpdateHTTPServerLogging | ( | bool | enable | ) |
Change logging level for libevent.
Removes BCLog::LIBEVENT from log categories if libevent doesn't support debug logging.
Definition at line 403 of file httpserver.cpp.
|
static |
Bound listening sockets.
Definition at line 144 of file httpserver.cpp.
|
static |
|
static |
HTTP server.
Definition at line 136 of file httpserver.cpp.
|
static |
Definition at line 417 of file httpserver.cpp.
|
static |
Definition at line 418 of file httpserver.cpp.
|
static |
Maximum size of http request (request line + headers)
Definition at line 37 of file httpserver.cpp.
|
static |
Handlers for (sub)paths.
Definition at line 142 of file httpserver.cpp.
|
static |
List of subnets to allow RPC connections from.
Definition at line 138 of file httpserver.cpp.
|
static |
Work queue for handling longer requests off the event loop thread.
Definition at line 140 of file httpserver.cpp.