restinio::connection_state::notice_t Class Reference

An object with info about connection to be passed to state listener. More...

#include <connection_state_listener.hpp>

Public Member Functions
	notice_t (connection_id_t conn_id, endpoint_t remote_endpoint, cause_t cause)
	Initializing constructor. More...
connection_id_t	connection_id () const noexcept
	Get the connection id. More...
endpoint_t	remote_endpoint () const noexcept
	Get the remote endpoint for the connection. More...
cause_t	cause () const noexcept
	Get the cause for the notification. More...

Private Attributes
connection_id_t	m_conn_id
endpoint_t	m_remote_endpoint
cause_t	m_cause

Detailed Description

An object with info about connection to be passed to state listener.

That object contains available information of the connection for that state listener is called.

NOTE. Content of this type can be changed in future versions of RESTinio.

Since

v.0.5.1

Definition at line 50 of file connection_state_listener.hpp.

Constructor & Destructor Documentation

notice_t()

restinio::connection_state::notice_t::notice_t ( connection_id_t  conn_id, endpoint_t  remote_endpoint, cause_t  cause  )

inline

Initializing constructor.

Definition at line 58 of file connection_state_listener.hpp.

Member Function Documentation

cause()

cause_t restinio::connection_state::notice_t::cause ( ) const

inlinenoexcept

Get the cause for the notification.

Definition at line 77 of file connection_state_listener.hpp.

connection_id()

connection_id_t restinio::connection_state::notice_t::connection_id ( ) const

inlinenoexcept

Get the connection id.

Definition at line 69 of file connection_state_listener.hpp.

remote_endpoint()

endpoint_t restinio::connection_state::notice_t::remote_endpoint ( ) const

inlinenoexcept

Get the remote endpoint for the connection.

Definition at line 73 of file connection_state_listener.hpp.

Member Data Documentation

m_cause

cause_t restinio::connection_state::notice_t::m_cause

private

Definition at line 54 of file connection_state_listener.hpp.

m_conn_id

connection_id_t restinio::connection_state::notice_t::m_conn_id

private

Definition at line 52 of file connection_state_listener.hpp.

m_remote_endpoint

endpoint_t restinio::connection_state::notice_t::m_remote_endpoint

private

Definition at line 53 of file connection_state_listener.hpp.

---

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

• restinio/connection_state_listener.hpp