seastar::httpd::api_registry Class Reference

Inheritance diagram for seastar::httpd::api_registry:

Public Member Functions
	api_registry (routes &routes, const sstring &file_directory, const sstring &base_path)
future< std::unique_ptr< http::reply > >	handle (const sstring &path, std::unique_ptr< http::request > req, std::unique_ptr< http::reply > rep) override
void	reg (const sstring &api, const sstring &description, const sstring &alternative_path="")
void	set_route (handler_base *h)
handler_base &	mandatory (const sstring &param)
void	verify_mandatory_params (const http::request &req) const

Protected Attributes
sstring	_base_path
sstring	_file_directory
routes &	_routes

Member Function Documentation

handle()

future< std::unique_ptr< http::reply > > seastar::httpd::api_registry::handle ( const sstring &  path, std::unique_ptr< http::request >  req, std::unique_ptr< http::reply >  rep  )

inlineoverridevirtual

All handlers should implement this method. It fill the reply according to the request.

Parameters

path	the url path used in this call
req	the original request
rep	the reply

Implements seastar::httpd::handler_base.

mandatory()

handler_base & seastar::httpd::handler_base::mandatory ( const sstring &  param )

inlineinherited

Add a mandatory parameter

Parameters

param

a parameter name

Returns

a reference to the handler

verify_mandatory_params()

void seastar::httpd::handler_base::verify_mandatory_params ( const http::request &  req ) const

inlineinherited

Check if all mandatory parameters exist in the request. if any param does not exist, the function would throw a missing_param_exception

Parameters

params

req the http request

---

The documentation for this class was generated from the following file:

• seastar/http/api_docs.hh