web::ng::ConnectionMetadata Class Reference

An interface for a connection metadata class. More...

#include <Connection.hpp>

Inheritance diagram for web::ng::ConnectionMetadata:

Collaboration diagram for web::ng::ConnectionMetadata:

Public Member Functions
	ConnectionMetadata (std::string ip, util::TagDecoratorFactory const &tagDecoratorFactory)
	Construct a new ConnectionMetadata object.
virtual bool	wasUpgraded () const =0
	Whether the connection was upgraded. Upgraded connections are websocket connections.
std::string const &	ip () const
	Get the ip of the client.
void	setIp (std::string newIp)
	Set the ip of the client.
bool	isAdmin () const
	Get whether the client is an admin.
template<std::invocable T>
void	setIsAdmin (T &&setter)
	Set the isAdmin field.
Public Member Functions inherited from util::Taggable
	Taggable (Taggable &&)=default
Taggable &	operator= (Taggable &&)=default
BaseTagDecorator const &	tag () const
	Getter for tag decorator.

Protected Attributes
std::string	ip_
std::optional< bool >	isAdmin_

Additional Inherited Members
Protected Member Functions inherited from util::Taggable
	Taggable (util::TagDecoratorFactory const &tagFactory)
	New Taggable from a specified factory.

Detailed Description

An interface for a connection metadata class.

Constructor & Destructor Documentation

ConnectionMetadata()

web::ng::ConnectionMetadata::ConnectionMetadata	(	std::string	ip,
		util::TagDecoratorFactory const &	tagDecoratorFactory )

Construct a new ConnectionMetadata object.

Parameters

ip	The client ip.
tagDecoratorFactory	The factory for creating tag decorators.

Member Function Documentation

ip()

std::string const & web::ng::ConnectionMetadata::ip

(

)

const

Get the ip of the client.

Returns

The ip of the client.

isAdmin()

bool web::ng::ConnectionMetadata::isAdmin

(

)

const

Get whether the client is an admin.

Returns

true if the client is an admin.

setIp()

void web::ng::ConnectionMetadata::setIp ( std::string newIp )

inline

Set the ip of the client.

Parameters

newIp

The new ip to set.

setIsAdmin()

template<std::invocable T>

void web::ng::ConnectionMetadata::setIsAdmin ( T && setter )

inline

Set the isAdmin field.

Note

This function is lazy, it will update isAdmin only if it is not set yet.

Template Parameters

T	The invocable type of the function to call to set the isAdmin.

Parameters

setter

The function to call to set the isAdmin.

wasUpgraded()

virtual bool web::ng::ConnectionMetadata::wasUpgraded ( ) const

pure virtual

Whether the connection was upgraded. Upgraded connections are websocket connections.

Returns

true if the connection was upgraded.

Implemented in web::ng::impl::HttpConnection< StreamType >, web::ng::impl::HttpConnection< boost::asio::ssl::stream< boost::beast::tcp_stream > >, web::ng::impl::HttpConnection< boost::beast::tcp_stream >, web::ng::impl::WsConnection< StreamType >, web::ng::impl::WsConnection< boost::asio::ssl::stream< boost::beast::tcp_stream > >, and web::ng::impl::WsConnection< boost::beast::tcp_stream >.

---

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

• /__w/clio/clio/src/web/ng/Connection.hpp
• /__w/clio/clio/src/web/ng/Connection.cpp