Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
web::ng::impl::UpgradableConnection Class Referenceabstract
Inheritance diagram for web::ng::impl::UpgradableConnection:
Inheritance graph
[legend]
Collaboration diagram for web::ng::impl::UpgradableConnection:
Collaboration graph
[legend]

Public Member Functions

virtual std::expected< bool, Error > isUpgradeRequested (boost::asio::yield_context yield)=0
virtual std::expected< ConnectionPtr, Error > upgrade (util::TagDecoratorFactory const &tagDecoratorFactory, boost::asio::yield_context yield)=0
virtual std::expected< void, Error > sendRaw (boost::beast::http::response< boost::beast::http::string_body > response, boost::asio::yield_context yield)=0
 Connection (std::string ip, boost::beast::flat_buffer buffer, util::TagDecoratorFactory const &tagDecoratorFactory)
 Construct a new Connection object.
Public Member Functions inherited from web::ng::Connection
 Connection (std::string ip, boost::beast::flat_buffer buffer, util::TagDecoratorFactory const &tagDecoratorFactory)
 Construct a new Connection object.
virtual void setTimeout (std::chrono::steady_clock::duration newTimeout)=0
 Get the timeout for send, receive, and close operations. For WebSocket connections, this is the ping interval.
virtual std::expected< void, Error > send (Response response, boost::asio::yield_context yield)=0
 Send a response to the client.
virtual std::expected< Request, Error > receive (boost::asio::yield_context yield)=0
 Receive a request from the client.
virtual void close (boost::asio::yield_context yield)=0
 Gracefully close the connection.
Public Member Functions inherited from web::ng::ConnectionMetadata
 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.

Additional Inherited Members

Static Public Attributes inherited from web::ng::Connection
static constexpr std::chrono::steady_clock::duration kDEFAULT_TIMEOUT = std::chrono::seconds{11}
 The default timeout for send, receive, and close operations.
Protected Member Functions inherited from util::Taggable
 Taggable (util::TagDecoratorFactory const &tagFactory)
 New Taggable from a specified factory.
Protected Attributes inherited from web::ng::Connection
boost::beast::flat_buffer buffer_
Protected Attributes inherited from web::ng::ConnectionMetadata
std::string ip_
std::optional< bool > isAdmin_

Member Function Documentation

◆ Connection()

web::ng::Connection::Connection ( std::string ip,
boost::beast::flat_buffer buffer,
util::TagDecoratorFactory const & tagDecoratorFactory )

Construct a new Connection object.

Parameters
ipThe client ip.
bufferThe buffer to use for reading and writing.
tagDecoratorFactoryThe factory for creating tag decorators.
The documentation for this class was generated from the following file: