WebServerControl::ServerActionOptions Struct Reference

Options to be passed to addServerAction. More...

#include <WebServerControl.h>

Public Member Functions
	ServerActionOptions ()
bool	getRequireWaiting () const
void	setRequireWaiting (const bool value, const Moose::PassKey< WebServerControl >)
	Set the require waiting flag; only accessible by the WebServerControl. More...
bool	getRequireInitialized () const
void	setRequireInitialized (const bool value, const Moose::PassKey< WebServerControl >)
	Set the require initialized flag; only accessible by the WebServerControl. More...
const std::set< std::string >	getRequiredJSONKeys () const
void	requireJSONKey (const std::string &key)
	Append a key to be required in JSON in the request data. More...
void	requireJSONKeys (std::initializer_list< std::string > &&keys)
	Append keys to be required in JSON in the request data. More...

Private Attributes
bool	_require_waiting
	Whether or not to require waiting. More...
bool	_require_initialized
	Whether or not to require initialization. More...
std::set< std::string >	_required_json_keys
	JSON keys that are required in the data. More...

Detailed Description

Options to be passed to addServerAction.

Definition at line 188 of file WebServerControl.h.

Constructor & Destructor Documentation

ServerActionOptions()

WebServerControl::ServerActionOptions::ServerActionOptions ( )

inline

Definition at line 190 of file WebServerControl.h.

: _require_waiting(true), _require_initialized(true) {}

Member Function Documentation

getRequiredJSONKeys()

const std::set<std::string> WebServerControl::ServerActionOptions::getRequiredJSONKeys ( ) const

inline

Returns

The JSON keys that are required in the request data

Definition at line 219 of file WebServerControl.h.

{ return _required_json_keys; }

getRequireInitialized()

bool WebServerControl::ServerActionOptions::getRequireInitialized ( ) const

inline

Returns

Whether or not to require initialization

Definition at line 207 of file WebServerControl.h.

{ return _require_initialized; }

getRequireWaiting()

bool WebServerControl::ServerActionOptions::getRequireWaiting ( ) const

inline

Returns

Whether or not to require waiting

Definition at line 195 of file WebServerControl.h.

{ return _require_waiting; }

requireJSONKey()

void WebServerControl::ServerActionOptions::requireJSONKey ( const std::string &  key )

inline

Append a key to be required in JSON in the request data.

Definition at line 223 of file WebServerControl.h.

Referenced by WebServerControl::addServerActionsInternal().

{ _required_json_keys.insert(key); }

requireJSONKeys()

void WebServerControl::ServerActionOptions::requireJSONKeys ( std::initializer_list< std::string > &&  keys )

inline

Append keys to be required in JSON in the request data.

Definition at line 227 of file WebServerControl.h.

Referenced by WebServerControl::addServerActionsInternal().

    {
      _required_json_keys.insert(keys);
    }

setRequireInitialized()

void WebServerControl::ServerActionOptions::setRequireInitialized ( const bool  value, const Moose::PassKey< WebServerControl >    )

inline

Set the require initialized flag; only accessible by the WebServerControl.

Definition at line 211 of file WebServerControl.h.

Referenced by WebServerControl::addServerActionsInternal().

    {
      _require_initialized = value;
    }

setRequireWaiting()

void WebServerControl::ServerActionOptions::setRequireWaiting ( const bool  value, const Moose::PassKey< WebServerControl >    )

inline

Set the require waiting flag; only accessible by the WebServerControl.

Definition at line 199 of file WebServerControl.h.

Referenced by WebServerControl::addServerActionsInternal().

    {
      _require_waiting = value;
    }

Member Data Documentation

_require_initialized

bool WebServerControl::ServerActionOptions::_require_initialized

private

Whether or not to require initialization.

Definition at line 236 of file WebServerControl.h.

Referenced by getRequireInitialized(), and setRequireInitialized().

_require_waiting

bool WebServerControl::ServerActionOptions::_require_waiting

private

Whether or not to require waiting.

Definition at line 234 of file WebServerControl.h.

Referenced by getRequireWaiting(), and setRequireWaiting().

_required_json_keys

std::set<std::string> WebServerControl::ServerActionOptions::_required_json_keys

private

JSON keys that are required in the data.

Definition at line 238 of file WebServerControl.h.

Referenced by getRequiredJSONKeys(), requireJSONKey(), and requireJSONKeys().

---

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

• include/controls/WebServerControl.h