Leosac::Module::WebSockAPI::CRUDResourceHandler Class Reference

Base CRUD handler for use within the websocket module. More...

#include <CRUDResourceHandler.hpp>

Inheritance diagram for Leosac::Module::WebSockAPI::CRUDResourceHandler:

Collaboration diagram for Leosac::Module::WebSockAPI::CRUDResourceHandler:

Public Types
using	Factory = CRUDResourceHandlerUPtr(*)(RequestContext)
Public Types inherited from Leosac::Module::WebSockAPI::ICRUDResourceHandler
enum	Verb { Verb::CREATE, Verb::READ, Verb::UPDATE, Verb::DELETE }

Static Public Member Functions
static CRUDResourceHandlerUPtr	instanciate (RequestContext)

Protected Member Functions
	CRUDResourceHandler (RequestContext ctx)
virtual UserSecurityContext &	security_context () const override
	Helper function that returns the security context. More...

Protected Attributes
RequestContext	ctx_

Additional Inherited Members
Public Member Functions inherited from Leosac::Module::WebSockAPI::ICRUDResourceHandler
boost::optional< json >	process (const ClientMessage &msg)
Protected Types inherited from Leosac::Module::WebSockAPI::ICRUDResourceHandler
using	ActionActionParam = std::pair< SecurityContext::Action, SecurityContext::ActionParam >
	A pair of Action and a generic ActionParam union. More...

Detailed Description

Base CRUD handler for use within the websocket module.

Definition at line 84 of file CRUDResourceHandler.hpp.

Member Typedef Documentation

Factory

using Leosac::Module::WebSockAPI::CRUDResourceHandler::Factory = CRUDResourceHandlerUPtr (*)(RequestContext)

Definition at line 90 of file CRUDResourceHandler.hpp.

Constructor & Destructor Documentation

CRUDResourceHandler()

CRUDResourceHandler::CRUDResourceHandler ( RequestContext  ctx )

protected

Definition at line 86 of file CRUDResourceHandler.cpp.

Member Function Documentation

instanciate()

CRUDResourceHandlerUPtr CRUDResourceHandler::instanciate ( RequestContext  )

static

Definition at line 91 of file CRUDResourceHandler.cpp.

security_context()

UserSecurityContext & CRUDResourceHandler::security_context ( ) const

overrideprotectedvirtual

Helper function that returns the security context.

Implements Leosac::Module::WebSockAPI::ICRUDResourceHandler.

Definition at line 96 of file CRUDResourceHandler.cpp.

Member Data Documentation

ctx_

RequestContext Leosac::Module::WebSockAPI::CRUDResourceHandler::ctx_

protected

Definition at line 95 of file CRUDResourceHandler.hpp.

---

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

• src/modules/websock-api/api/CRUDResourceHandler.hpp
• src/modules/websock-api/api/CRUDResourceHandler.cpp