mirror of
https://github.com/matrix-construct/construct
synced 2024-05-29 08:13:46 +02:00
102 lines
3.4 KiB
C++
102 lines
3.4 KiB
C++
// Matrix Construct
|
|
//
|
|
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
|
// Copyright (C) 2016-2019 Jason Volk <jason@zemos.net>
|
|
//
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice is present in all copies. The
|
|
// full license for this software is available in the LICENSE file.
|
|
|
|
#pragma once
|
|
#define HAVE_IRCD_RESOURCE_METHOD_H
|
|
|
|
struct ircd::resource::method
|
|
{
|
|
enum flag :uint;
|
|
struct opts;
|
|
struct stats;
|
|
using handler = std::function<response (client &, request &)>;
|
|
|
|
static conf::item<seconds> default_timeout;
|
|
static conf::item<size_t> default_payload_max;
|
|
static ctx::dock idle_dock;
|
|
|
|
struct resource *resource;
|
|
string_view name;
|
|
handler function;
|
|
std::unique_ptr<const struct opts> opts;
|
|
std::unique_ptr<struct stats> stats;
|
|
unique_const_iterator<decltype(resource::methods)> methods_it;
|
|
|
|
bool content_length_acceptable(const http::request::head &) const;
|
|
bool mime_type_acceptable(const http::request::head &) const;
|
|
|
|
void handle_timeout(client &) const;
|
|
response call_handler(client &, request &);
|
|
|
|
public:
|
|
response operator()(client &, const http::request::head &, const string_view &content_partial);
|
|
|
|
method(struct resource &, const string_view &name, handler, struct opts);
|
|
method(struct resource &, const string_view &name, handler);
|
|
~method() noexcept;
|
|
};
|
|
|
|
/// Resource method option flags. Flag values enumerated here are restricted
|
|
/// to the lower half of the integer. The upper half is reserved for derived
|
|
/// resource methods and their own flags.
|
|
enum ircd::resource::method::flag
|
|
:uint
|
|
{
|
|
/// Options governing the frequency of requests are applied to method. If
|
|
/// not given, any set rate limiting options or their defaults are ignored.
|
|
RATE_LIMITED = 0x0001,
|
|
|
|
/// Method assumes responsibility for consuming HTTP content off socket.
|
|
/// If this flag is not set, all content will be consumed off the socket
|
|
/// into a buffer prior to the method call.
|
|
CONTENT_DISCRETION = 0x0002,
|
|
|
|
/// The TCP quick-ack feature will not be used prior to calling the method.
|
|
/// If this flag is not set the feature may be used if conditions permit.
|
|
DELAYED_ACK = 0x0004,
|
|
|
|
/// This option prevents TCP nodelay from being toggled at the end of the
|
|
/// request to flush the sendq; TCP delays are used by default.
|
|
RESPONSE_NOFLUSH = 0x0008,
|
|
|
|
/// This option TCP corks the response during the request.
|
|
RESPONSE_NOPUSH = 0x0010,
|
|
};
|
|
|
|
struct ircd::resource::method::opts
|
|
{
|
|
/// Option flags
|
|
std::underlying_type_t<method::flag> flags {0};
|
|
|
|
/// Timeout specific to this resource; 0 is automatic
|
|
seconds timeout {0};
|
|
|
|
/// The maximum size of the Content-Length for this method. Anything
|
|
/// larger will be summarily rejected with a 413. -1 is automatic.
|
|
size_t payload_max {-1UL};
|
|
|
|
/// MIME type; first part is the Registry (i.e application) and second
|
|
/// part is the format (i.e json). Empty value means nothing rejected.
|
|
std::pair<string_view, string_view> mime;
|
|
};
|
|
|
|
struct ircd::resource::method::stats
|
|
{
|
|
using item = ircd::stats::item<uint64_t>;
|
|
|
|
item pending; ///< Clients currently inside the method
|
|
item requests; ///< The method was found and called.
|
|
item timeouts; ///< The method's timeout was exceeded.
|
|
item completions; ///< The handler returned without throwing.
|
|
item internal_errors; ///< The handler threw a very bad exception.
|
|
|
|
stats(method &);
|
|
};
|