mantis::HttpUnit Class Reference

#include <http.h>

Public Member Functions
	HttpUnit ()
	~HttpUnit ()
void	Get (const std::string &path, const RouteHandlerFunc &handler, std::initializer_list< Middleware > middlewares={})
void	Post (const std::string &path, const RouteHandlerFunc &handler, std::initializer_list< Middleware > middlewares={})
void	Post (const std::string &path, const RouteHandlerFuncWithContentReader &handler, std::initializer_list< Middleware > middlewares={})
void	Patch (const std::string &path, const RouteHandlerFunc &handler, std::initializer_list< Middleware > middlewares={})
void	Patch (const std::string &path, const RouteHandlerFuncWithContentReader &handler, std::initializer_list< Middleware > middlewares={})
void	Delete (const std::string &path, const RouteHandlerFunc &handler, std::initializer_list< Middleware > middlewares={})
bool	listen (const std::string &host, const int &port)
	Bind to a port and start listening for requests.
void	close ()
	Close the HTTP server connection.
RouteRegistry &	routeRegistry ()
	Fetch the underlying route registry, check.
httplib::Server &	server ()
	Get a reference to the httplib::Server instance.

Static Public Member Functions
static Context &	context ()
static std::string	hashMultipartMetadata (const httplib::FormData &data)
	Generate hash for the file metadata.

Public Attributes
const std::string	_class_ = "mantis::HttpUnit"

Detailed Description

Class wrapper around httplib methods allowing for injection of the middleware and context functionality. By default, httplib supports pre/post global middlewares, we're therefore adding a layer to scope middlewares to specific routes.

Also, to allow sharing data between middlewares and handler func, we are adding Context in the handler functions.

Constructor & Destructor Documentation

HttpUnit()

mantis::HttpUnit::HttpUnit

(

)

~HttpUnit()

mantis::HttpUnit::~HttpUnit

(

)

Member Function Documentation

close()

void mantis::HttpUnit::close

(

)

Close the HTTP server connection.

context()

mantis::Context & mantis::HttpUnit::context ( )

static

Delete()

void mantis::HttpUnit::Delete	(	const std::string &	path,
		const RouteHandlerFunc &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

Get()

void mantis::HttpUnit::Get	(	const std::string &	path,
		const RouteHandlerFunc &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

hashMultipartMetadata()

std::string mantis::HttpUnit::hashMultipartMetadata ( const httplib::FormData &  data )

static

Generate hash for the file metadata.

Parameters

data	Multipart file reference

Returns

Hash

listen()

bool mantis::HttpUnit::listen	(	const std::string &	host,
		const int &	port
	)

Bind to a port and start listening for requests.

Parameters

host	HTTP server host.
port	HTTP server port.

Returns

Flag if successful or not.

Patch() [1/2]

void mantis::HttpUnit::Patch	(	const std::string &	path,
		const RouteHandlerFunc &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

Patch() [2/2]

void mantis::HttpUnit::Patch	(	const std::string &	path,
		const RouteHandlerFuncWithContentReader &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

Post() [1/2]

void mantis::HttpUnit::Post	(	const std::string &	path,
		const RouteHandlerFunc &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

Post() [2/2]

void mantis::HttpUnit::Post	(	const std::string &	path,
		const RouteHandlerFuncWithContentReader &	handler,
		std::initializer_list< Middleware >	middlewares = {}
	)

routeRegistry()

mantis::RouteRegistry & mantis::HttpUnit::routeRegistry

(

)

Fetch the underlying route registry, check.

See also

RouteRegistry.

Returns

Ref to the underlying route registry object.

server()

httplib::Server & mantis::HttpUnit::server

(

)

Get a reference to the httplib::Server instance.

Returns

A reference to the httplib server instance being used.

Member Data Documentation

_class_

const std::string mantis::HttpUnit::_class_ = "mantis::HttpUnit"

---

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

• /home/runner/work/mantis/mantis/include/mantis/core/http.h
• /home/runner/work/mantis/mantis/src/core/http.cpp