mirror of
https://github.com/scylladb/scylladb.git
synced 2026-04-21 17:10:35 +00:00
The http server handlers can sometimes need to perform async operation, specifically, when reading files from the disk. To support async behavior the handlers handle function will return a future, that will be propagate back, when the future will be ready it will return the reply to be sent. When switching from direct function call to future, there is also a need to switch from references to pointers. Note that while the request will be discarded, the reply will be propagate back via the future to the caller. Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
74 lines
1.9 KiB
C++
74 lines
1.9 KiB
C++
/*
|
|
* This file is open source software, licensed to you under the terms
|
|
* of the Apache License, Version 2.0 (the "License"). See the NOTICE file
|
|
* distributed with this work for additional information regarding copyright
|
|
* ownership. You may not use this file except in compliance with the License.
|
|
*
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
/*
|
|
* Copyright 2015 Cloudius Systems
|
|
*/
|
|
|
|
#ifndef HANDLERS_HH_
|
|
#define HANDLERS_HH_
|
|
|
|
#include "request.hh"
|
|
#include "common.hh"
|
|
#include "reply.hh"
|
|
#include "core/future-util.hh"
|
|
|
|
#include <unordered_map>
|
|
|
|
namespace httpd {
|
|
|
|
typedef const httpd::request& const_req;
|
|
|
|
/**
|
|
* handlers holds the logic for serving an incoming request.
|
|
* All handlers inherit from the base httpserver_handler and
|
|
* implement the handle method.
|
|
*
|
|
*/
|
|
class handler_base {
|
|
public:
|
|
/**
|
|
* All handlers should implement this method.
|
|
* It fill the reply according to the request.
|
|
* @param path the url path used in this call
|
|
* @param params optional parameter object
|
|
* @param req the original request
|
|
* @param rep the reply
|
|
*/
|
|
virtual future<std::unique_ptr<reply> > handle(const sstring& path,
|
|
std::unique_ptr<request> req, std::unique_ptr<reply> rep) = 0;
|
|
|
|
virtual ~handler_base() = default;
|
|
|
|
/**
|
|
* Add a mandatory parameter
|
|
* @param param a parameter name
|
|
* @return a reference to the handler
|
|
*/
|
|
handler_base& mandatory(const sstring& param) {
|
|
_mandatory_param.push_back(param);
|
|
return *this;
|
|
}
|
|
|
|
std::vector<sstring> _mandatory_param;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
#endif /* HANDLERS_HH_ */
|