Client request information object. More...

#include <server.hpp>

Public Member Functions
template<class Socket >
	request (const std::string &reqcmd, config &reqcfg, Socket reqsock, boost::asio::yield_context yield)
	Constructor. More...

Public Attributes
const std::string &	cmd

const config &	cfg

const any_socket_ptr	sock

const std::string	addr

boost::asio::yield_context	yield
	context of the coroutine the request is executed in async operations on sock can use it instead of a handler. More...

Detailed Description

Client request information object.

Contains data and metadata associated with a single request from a remote add-ons client, in a light-weight format for passing to request handlers.

Definition at line 56 of file server.hpp.

Constructor & Destructor Documentation

◆ request()

template<class Socket >

campaignd::server::request::request	(	const std::string &	reqcmd,
		config &	reqcfg,
		Socket	reqsock,
		boost::asio::yield_context	yield
	)

inline

Constructor.

Parameters

reqcmd	Request command.
reqcfg	Request WML body.
reqsock	Client socket that initiated the request.
yield	The function will suspend on write operation using this yield context

Note: Neither reqcmd nor reqcfg are copied into instances, so they are required to exist for as long as every request instance that uses them. Furthermore, reqcfg MUST NOT REFER TO A CONST OBJECT, since some code may modify it directly for performance reasons.

Definition at line 85 of file server.hpp.

Member Data Documentation

◆ addr

const std::string campaignd::server::request::addr

Definition at line 62 of file server.hpp.

Referenced by campaignd::server::handle_request_campaign(), campaignd::server::handle_upload(), and campaignd::server::validate_addon().

◆ cfg

const config& campaignd::server::request::cfg

Definition at line 59 of file server.hpp.

Referenced by campaignd::server::handle_change_passphrase(), campaignd::server::handle_delete(), campaignd::server::handle_request_campaign(), campaignd::server::handle_request_campaign_hash(), campaignd::server::handle_request_campaign_list(), campaignd::server::handle_upload(), and campaignd::server::validate_addon().

◆ cmd

const std::string& campaignd::server::request::cmd

Definition at line 58 of file server.hpp.

◆ sock

const any_socket_ptr campaignd::server::request::sock

Definition at line 61 of file server.hpp.

Referenced by campaignd::server::handle_change_passphrase(), campaignd::server::handle_delete(), campaignd::server::handle_request_campaign(), campaignd::server::handle_request_campaign_hash(), campaignd::server::handle_request_campaign_list(), campaignd::server::handle_request_terms(), campaignd::server::handle_server_id(), and campaignd::server::handle_upload().

◆ yield

boost::asio::yield_context campaignd::server::request::yield

context of the coroutine the request is executed in async operations on sock can use it instead of a handler.

Definition at line 68 of file server.hpp.

Referenced by campaignd::server::handle_request_campaign(), and campaignd::server::handle_request_campaign_hash().

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

server/campaignd/server.hpp

Public Member Functions

Public Attributes