web::http::experimental::listener::http_listener_config Class Reference

Configuration class used to set various options when constructing and http_listener instance. More...

#include <http_listener.h>

Public Member Functions
	http_listener_config ()
	Create an http_listener configuration with default options. More...
	http_listener_config (const http_listener_config &other)
	Copy constructor. More...
	http_listener_config (http_listener_config &&other)
	Move constructor. More...
http_listener_config &	operator= (const http_listener_config &rhs)
	Assignment operator. More...
http_listener_config &	operator= (http_listener_config &&rhs)
	Assignment operator. More...
utility::seconds	timeout () const
	Get the timeout More...
void	set_timeout (utility::seconds timeout)
	Set the timeout More...
const std::function< void(boost::asio::ssl::context &)> &	get_ssl_context_callback () const
	Get the callback of ssl context More...
void	set_ssl_context_callback (const std::function< void(boost::asio::ssl::context &)> &ssl_context_callback)
	Set the callback of ssl context More...

Detailed Description

Configuration class used to set various options when constructing and http_listener instance.

Constructor & Destructor Documentation

web::http::experimental::listener::http_listener_config::http_listener_config ( )

inline

Create an http_listener configuration with default options.

web::http::experimental::listener::http_listener_config::http_listener_config ( const http_listener_config &  other )

inline

Copy constructor.

Parameters

other

http_listener_config to copy.

web::http::experimental::listener::http_listener_config::http_listener_config ( http_listener_config &&  other )

inline

Move constructor.

Parameters

other

http_listener_config to move from.

Member Function Documentation

const std::function<void(boost::asio::ssl::context&)>& web::http::experimental::listener::http_listener_config::get_ssl_context_callback ( ) const

inline

Get the callback of ssl context

Returns

The function defined by the user of http_listener_config to configure a ssl context.

http_listener_config& web::http::experimental::listener::http_listener_config::operator= ( const http_listener_config &  rhs )

inline

Assignment operator.

Returns

http_listener_config instance.

http_listener_config& web::http::experimental::listener::http_listener_config::operator= ( http_listener_config &&  rhs )

inline

Assignment operator.

Returns

http_listener_config instance.

void web::http::experimental::listener::http_listener_config::set_ssl_context_callback ( const std::function< void(boost::asio::ssl::context &)> &  ssl_context_callback )

inline

Set the callback of ssl context

Parameters

ssl_context_callback

The function to configure a ssl context which will setup https connections.

void web::http::experimental::listener::http_listener_config::set_timeout ( utility::seconds  timeout )

inline

Set the timeout

Parameters

timeout

The timeout (in seconds) used for each send and receive operation on the client.

utility::seconds web::http::experimental::listener::http_listener_config::timeout ( ) const

inline

Get the timeout

Returns

The timeout (in seconds).

---

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

• include/cpprest/http_listener.h