Leosac  0.8.0
Open Source Access Control
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Leosac::Module::WebSockAPI::Restart Class Reference

Restart the Leosac server. More...

#include <Restart.hpp>

+ Inheritance diagram for Leosac::Module::WebSockAPI::Restart:
+ Collaboration diagram for Leosac::Module::WebSockAPI::Restart:

Public Member Functions

 Restart (RequestContext ctx)
 
- Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
 MethodHandler (RequestContext ctx)
 
virtual ~MethodHandler ()=default
 
json process (const ClientMessage &msg)
 The public process() method. More...
 
UserSecurityContext & security_context ()
 
ExecutionContext exec_context ()
 Returns a representation of the execution context of this request. More...
 

Static Public Member Functions

static MethodHandlerUPtr create (RequestContext)
 
- Static Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
static MethodHandlerUPtr create (RequestContext)
 An example method that should be implemented in all subclasses. More...
 

Protected Member Functions

std::vector< ActionActionParam > required_permission (const json &req) const override
 Return a list of "Action" / "ActionParam" that must pass before the request is processed. More...
 

Private Member Functions

virtual json process_impl (const json &req) override
 The API method implementation. More...
 

Additional Inherited Members

- Public Types inherited from Leosac::Module::WebSockAPI::MethodHandler
using Factory = MethodHandlerUPtr(*)(RequestContext)
 
- Protected Attributes inherited from Leosac::Module::WebSockAPI::MethodHandler
RequestContext ctx_
 

Detailed Description

Restart the Leosac server.

The request's body is empty.

Definition at line 35 of file Restart.hpp.

Constructor & Destructor Documentation

◆ Restart()

Leosac::Module::WebSockAPI::Restart::Restart ( RequestContext  ctx)

Definition at line 31 of file Restart.cpp.

Member Function Documentation

◆ create()

MethodHandlerUPtr Leosac::Module::WebSockAPI::Restart::create ( RequestContext  rc)
static

Definition at line 36 of file Restart.cpp.

◆ process_impl()

json Leosac::Module::WebSockAPI::Restart::process_impl ( const json &  req)
overrideprivatevirtual

The API method implementation.

Returns
A json object that will be assigned to the content key in the JSON message sent to the client.

Implements Leosac::Module::WebSockAPI::MethodHandler.

Definition at line 48 of file Restart.cpp.

◆ required_permission()

std::vector< ActionActionParam > Leosac::Module::WebSockAPI::Restart::required_permission ( const json &  req) const
overrideprotectedvirtual

Return a list of "Action" / "ActionParam" that must pass before the request is processed.

Implements Leosac::Module::WebSockAPI::MethodHandler.

Definition at line 41 of file Restart.cpp.

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