netflex::http::server Class Reference

#include <server.hpp>

Public Member Functions
	server (void)
	default ctor
	~server (void)=default
	default dtor
	server (const server &)=delete
	copy ctor
server &	operator= (const server &)=delete
	assignment operator
server &	add_route (const routing::route &route)
server &	add_routes (const std::vector< routing::route > &routes)
server &	set_route (const std::vector< routing::route > &routes)
server &	add_middleware (const routing::middleware_t &middleware)
server &	add_middlewares (const std::list< routing::middleware_t > &middlewares)
server &	set_middlewares (const std::list< routing::middleware_t > &middlewares)
void	start (const std::string &host="0.0.0.0", unsigned int port=3000)
void	stop (void)
bool	is_running (void) const

Detailed Description

http server itself listen for incoming connection, detect requests, parse them and dispatch them before sending the appropriate responses

Member Function Documentation

add_middleware()

server& netflex::http::server::add_middleware

(

const routing::middleware_t &

middleware

)

add middleware to the server added middleware is added at the highest level (on top of all the previously added middleware) this mean that the added middleware will be the last to be executed

Parameters

middleware

middleware to be added

Returns

reference to the current object

add_middlewares()

server& netflex::http::server::add_middlewares

(

const std::list< routing::middleware_t > &

middlewares

)

add multiple middlewares to the server added middlewares are added at the highest level (on top of all the previously added middleware) this mean that the added middlewares will be the last to be executed middleares should be ranged from the lowest to the highest level

Parameters

middlewares

middlewares to be added

Returns

reference to the current object

add_route()

server& netflex::http::server::add_route

(

const routing::route &

route

)

add route to the server

Parameters

route

route to be added

Returns

reference to the current object

add_routes()

server& netflex::http::server::add_routes

(

const std::vector< routing::route > &

routes

)

add multiple routes to the server

Parameters

routes

routes to be added

Returns

reference to the current object

is_running()

bool netflex::http::server::is_running

(

void

)

const

Returns

whether the server is currently running or not

set_middlewares()

server& netflex::http::server::set_middlewares

(

const std::list< routing::middleware_t > &

middlewares

)

set middlewares for the server middleares should be ranged from the lowest to the highest level

Parameters

middlewares

middlewares to be added

Returns

reference to the current object

set_route()

server& netflex::http::server::set_route

(

const std::vector< routing::route > &

routes

)

set routes for the server

Parameters

routes

routes to be set

Returns

reference to the current object

start()

void netflex::http::server::start	(	const std::string &	host = "0.0.0.0",
		unsigned int	port = 3000
	)

start the server at the given host and port

Parameters

host	host to bind
port	port to bind

stop()

void netflex::http::server::stop

(

void

)

stop the server

---

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

• includes/netflex/http/server.hpp