Leosac::Module::Piface::CRUDHandler Class Reference

CRUD Handler for GPIO backed by Piface module. More...

#include <CRUDHandler.hpp>

Inheritance diagram for Leosac::Module::Piface::CRUDHandler:

Collaboration diagram for Leosac::Module::Piface::CRUDHandler:

Public Member Functions
	CRUDHandler (const WebSockAPI::RequestContext &ctx)
std::vector< ActionActionParam >	required_permission (Verb verb, const WebSockAPI::json &req) const override
boost::optional< WebSockAPI::json >	create_impl (const WebSockAPI::json &req) override
boost::optional< WebSockAPI::json >	read_impl (const WebSockAPI::json &req) override
boost::optional< WebSockAPI::json >	update_impl (const WebSockAPI::json &req) override
boost::optional< WebSockAPI::json >	delete_impl (const WebSockAPI::json &req) override
Public Member Functions inherited from Leosac::Module::WebSockAPI::ICRUDResourceHandler
boost::optional< json >	process (const ClientMessage &msg)

Static Public Member Functions
static WebSockAPI::CRUDResourceHandlerUPtr	instanciate (WebSockAPI::RequestContext)
Static Public Member Functions inherited from Leosac::Module::WebSockAPI::CRUDResourceHandler
static CRUDResourceHandlerUPtr	instanciate (RequestContext)

Additional Inherited Members
Public Types inherited from Leosac::Module::WebSockAPI::CRUDResourceHandler
using	Factory = CRUDResourceHandlerUPtr(*)(RequestContext)
Public Types inherited from Leosac::Module::WebSockAPI::ICRUDResourceHandler
enum	Verb { Verb::CREATE, Verb::READ, Verb::UPDATE, Verb::DELETE }
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...
Protected Member Functions inherited from Leosac::Module::WebSockAPI::CRUDResourceHandler
	CRUDResourceHandler (RequestContext ctx)
virtual UserSecurityContext &	security_context () const override
	Helper function that returns the security context. More...
Protected Attributes inherited from Leosac::Module::WebSockAPI::CRUDResourceHandler
RequestContext	ctx_

Detailed Description

CRUD Handler for GPIO backed by Piface module.

Methods in this handler will be invoked on the Websocket thread.

Definition at line 34 of file CRUDHandler.hpp.

Constructor & Destructor Documentation

CRUDHandler()

Leosac::Module::Piface::CRUDHandler::CRUDHandler

(

const WebSockAPI::RequestContext &

ctx

)

Definition at line 164 of file CRUDHandler.cpp.

Member Function Documentation

create_impl()

boost::optional< json > Leosac::Module::Piface::CRUDHandler::create_impl ( const WebSockAPI::json &  req )

overridevirtual

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

Definition at line 73 of file CRUDHandler.cpp.

delete_impl()

boost::optional< json > Leosac::Module::Piface::CRUDHandler::delete_impl ( const WebSockAPI::json &  req )

overridevirtual

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

Definition at line 151 of file CRUDHandler.cpp.

instanciate()

WebSockAPI::CRUDResourceHandlerUPtr Leosac::Module::Piface::CRUDHandler::instanciate ( WebSockAPI::RequestContext  ctx )

static

Definition at line 170 of file CRUDHandler.cpp.

read_impl()

boost::optional< json > Leosac::Module::Piface::CRUDHandler::read_impl ( const WebSockAPI::json &  req )

overridevirtual

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

Definition at line 99 of file CRUDHandler.cpp.

required_permission()

std::vector< WebSockAPI::ICRUDResourceHandler::ActionActionParam > Leosac::Module::Piface::CRUDHandler::required_permission ( Verb  verb, const WebSockAPI::json &  req  ) const

overridevirtual

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

Definition at line 37 of file CRUDHandler.cpp.

update_impl()

boost::optional< json > Leosac::Module::Piface::CRUDHandler::update_impl ( const WebSockAPI::json &  req )

overridevirtual

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

Definition at line 135 of file CRUDHandler.cpp.

---

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

• src/modules/pifacedigital/CRUDHandler.hpp
• src/modules/pifacedigital/CRUDHandler.cpp