crow::WebSocketRule Class Reference

#include <routing.h>

Inheritance diagram for crow::WebSocketRule:

Collaboration diagram for crow::WebSocketRule:

Public Member Functions
	WebSocketRule (std::string rule)
void	validate () override
void	handle (const request &, response &res, const routing_params &) override
void	handle_upgrade (const request &req, response &, SocketAdaptor &&adaptor) override
template<typename Func >
self_t &	onopen (Func f)
template<typename Func >
self_t &	onmessage (Func f)
template<typename Func >
self_t &	onclose (Func f)
template<typename Func >
self_t &	onerror (Func f)
Public Member Functions inherited from crow::BaseRule
	BaseRule (std::string rule)
virtual	~BaseRule ()
std::unique_ptr< BaseRule >	upgrade ()
uint32_t	get_methods ()

Protected Attributes
std::function< void(crow::websocket::connection &)>	open_handler_
std::function< void(crow::websocket::connection &, const std::string &, bool)>	message_handler_
std::function< void(crow::websocket::connection &, const std::string &)>	close_handler_
std::function< void(crow::websocket::connection &)>	error_handler_
Protected Attributes inherited from crow::BaseRule
uint32_t	methods_ {1<<(int)HTTPMethod::Get}
std::string	rule_
std::string	name_
std::unique_ptr< BaseRule >	rule_to_upgrade_

Private Types
using	self_t = WebSocketRule

Member Typedef Documentation

self_t

using crow::WebSocketRule::self_t = WebSocketRule

private

Constructor & Destructor Documentation

WebSocketRule()

crow::WebSocketRule::WebSocketRule ( std::string  rule )

inline

Member Function Documentation

handle()

void crow::WebSocketRule::handle ( const request &  , response &  res, const routing_params &    )

inlineoverridevirtual

Implements crow::BaseRule.

handle_upgrade()

void crow::WebSocketRule::handle_upgrade ( const request &  req, response &  , SocketAdaptor &&  adaptor  )

inlineoverridevirtual

Reimplemented from crow::BaseRule.

onclose()

template<typename Func >

self_t& crow::WebSocketRule::onclose ( Func  f )

inline

onerror()

template<typename Func >

self_t& crow::WebSocketRule::onerror ( Func  f )

inline

onmessage()

template<typename Func >

self_t& crow::WebSocketRule::onmessage ( Func  f )

inline

onopen()

template<typename Func >

self_t& crow::WebSocketRule::onopen ( Func  f )

inline

validate()

void crow::WebSocketRule::validate ( )

inlineoverridevirtual

Implements crow::BaseRule.

Member Data Documentation

close_handler_

std::function<void(crow::websocket::connection&, const std::string&)> crow::WebSocketRule::close_handler_

protected

error_handler_

std::function<void(crow::websocket::connection&)> crow::WebSocketRule::error_handler_

protected

message_handler_

std::function<void(crow::websocket::connection&, const std::string&, bool)> crow::WebSocketRule::message_handler_

protected

open_handler_

std::function<void(crow::websocket::connection&)> crow::WebSocketRule::open_handler_

protected

---

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

• src/wallet/micro_core/ext/crow/routing.h