WebServerControl::Request Struct Reference

Represents a request from the client. More...

#include <WebServerControl.h>

Public Member Functions
	Request ()=default
bool	hasJSON () const
const nlohmann::json &	getJSON () const
void	setJSON (const nlohmann::json &json, const Moose::PassKey< WebServerControl >)
	Set the JSON data in the request. More...

Private Attributes
std::optional< nlohmann::json >	_json
	The underlying JSON data, if any. More...

Detailed Description

Represents a request from the client.

Definition at line 96 of file WebServerControl.h.

Constructor & Destructor Documentation

Request()

WebServerControl::Request::Request ( )

default

Member Function Documentation

getJSON()

const nlohmann::json & WebServerControl::Request::getJSON

(

)

const

Returns

Get the JSON data from the request

Definition at line 820 of file WebServerControl.C.

Referenced by WebServerControl::addServerActionsInternal().

{
  if (!hasJSON())
    throw std::runtime_error("Request does not contain JSON when it should");
  return *_json;
}

hasJSON()

bool WebServerControl::Request::hasJSON ( ) const

inline

Returns

Whether or not the request has JSON data

Definition at line 103 of file WebServerControl.h.

Referenced by getJSON().

{ return _json.has_value(); }

setJSON()

void WebServerControl::Request::setJSON ( const nlohmann::json &  json, const Moose::PassKey< WebServerControl >    )

inline

Set the JSON data in the request.

Definition at line 113 of file WebServerControl.h.

    {
      _json = json;
    }

Member Data Documentation

_json

std::optional<nlohmann::json> WebServerControl::Request::_json

private

The underlying JSON data, if any.

Definition at line 120 of file WebServerControl.h.

Referenced by getJSON(), hasJSON(), and setJSON().

---

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

• include/controls/WebServerControl.h
• src/controls/WebServerControl.C