Context that is used by the Webserver to pass around information about an incoming request. More...

#include <Context.hpp>

Inheritance diagram for web::Context:

Collaboration diagram for web::Context:

[legend]

Public Member Functions
	Context (boost::asio::yield_context yield, std::string command, std::uint32_t apiVersion, boost::json::object params, SubscriptionContextPtr subscriptionContext, util::TagDecoratorFactory const &tagFactory, data::LedgerRange const &range, std::string clientIp, bool isAdmin)
	Create a new Context instance.
	Context (Context &&)=default
Context &	operator= (Context &&)=default
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
Protected Member Functions inherited from util::Taggable
	Taggable (util::TagDecoratorFactory const &tagFactory)
	New Taggable from a specified factory.

Detailed Description

Context that is used by the Webserver to pass around information about an incoming request.

Constructor & Destructor Documentation

web::Context::Context	(	boost::asio::yield_context	yield,
		std::string	command,
		std::uint32_t	apiVersion,
		boost::json::object	params,
		SubscriptionContextPtr	subscriptionContext,
		util::TagDecoratorFactory const &	tagFactory,
		data::LedgerRange const &	range,
		std::string	clientIp,
		bool	isAdmin )

inline

Create a new Context instance.

Parameters

yield	The coroutine context
command	The method/command requested
apiVersion	The api_version parsed from the request
params	Request's parameters/data as a JSON object
subscriptionContext	The subscription context of the connection
tagFactory	A factory that is used to generate tags to track requests and connections
range	The ledger range that is available at the time of the request
clientIp	IP of the peer
isAdmin	Whether the peer has admin privileges

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