include/ipmid/handler.hpp

98  * @brief Handler base class for dealing with IPMI request/response
110     /** @brief wrap the call to the registered handler with the request
132     /** @brief call the registered handler with the request
149  * @brief Main IPMI handler class
156 template <typename Handler>
160     explicit IpmiHandler(Handler&& handler) :  in IpmiHandler()  argument
161         handler_(std::forward<Handler>(handler))  in IpmiHandler()
165     Handler handler_;
167     /** @brief call the registered handler with the request
175      * Because this is the new variety of IPMI handler, this is the function
189         using CallbackSig = boost::callable_traits::args_t<Handler>;  in executeCallback()
194         using ResultType = boost::callable_traits::return_type_t<Handler>;  in executeCallback()
216          * handler signature, it will allow for the handler to unpack optional  in executeCallback()
270             lg2::info("Handler produced exception, NetFn: {NETFN}, "  in executeCallback()
278             lg2::error("Handler failed to catch exception, NetFn: {NETFN}, "  in executeCallback()
291             lg2::error("Handler failed to catch exception, NetFn: {NETFN}, "  in executeCallback()
312  * @brief Legacy IPMI handler class
325     explicit IpmiHandler(const ipmid_callback_t& handler, void* ctx = nullptr) :  in IpmiHandler()  argument
326         handler_(handler), handlerCtx(ctx)  in IpmiHandler()
333     /** @brief call the registered handler with the request
341      * Because this is the legacy variety of IPMI handler, this function does
367             lg2::info("Legacy Handler produced exception, NetFn: {NETFN}, "  in executeCallback()
375             lg2::error("Legacy Handler failed to catch exception, "  in executeCallback()
388             lg2::error("Handler failed to catch exception, NetFn: {NETFN}, "  in executeCallback()
401  * @brief Legacy IPMI OEM handler class
411 class IpmiHandler<oem::Handler> final : public HandlerBase
414     explicit IpmiHandler(const oem::Handler& handler) : handler_(handler) {}  in IpmiHandler()  argument
417     oem::Handler handler_;
419     /** @brief call the registered handler with the request
427      * Because this is the legacy variety of IPMI handler, this function does
453             lg2::info("Legacy OEM Handler produced exception, NetFn: {NETFN}, "  in executeCallback()
461             lg2::error("Legacy OEM Handler failed to catch exception, "  in executeCallback()
487  * @brief create a legacy IPMI handler class and return a shared_ptr
490  * shared_ptr that owns the Handler object.
494  * @param handler the function pointer to the callback
496  * @return A shared_ptr to the created handler object
498 inline auto makeLegacyHandler(const ipmid_callback_t& handler,  in makeLegacyHandler()  argument
501     HandlerBase::ptr ptr(new IpmiHandler<ipmid_callback_t>(handler, ctx));  in makeLegacyHandler()
506  * @brief create a legacy IPMI OEM handler class and return a shared_ptr
509  * shared_ptr that owns the Handler object.
513  * @param handler the function pointer to the callback
515  * @return A shared_ptr to the created handler object
517 inline auto makeLegacyHandler(oem::Handler&& handler)  in makeLegacyHandler()  argument
520         new IpmiHandler<oem::Handler>(std::forward<oem::Handler>(handler)));  in makeLegacyHandler()
526  * @brief create an IPMI handler class and return a shared_ptr
529  * shared_ptr that owns the Handler object.
533  * @param handler the function pointer to the callback
535  * @return A shared_ptr to the created handler object
537 template <typename Handler>
538 inline auto makeHandler(Handler&& handler)  in makeHandler()  argument
541         new IpmiHandler<Handler>(std::forward<Handler>(handler)));  in makeHandler()
548 // IPMI command handler registration implementation
550                      ::ipmi::HandlerBase::ptr handler);
552                           ::ipmi::HandlerBase::ptr handler);
554                         ::ipmi::HandlerBase::ptr handler);
559  * @brief main IPMI handler registration function
561  * This function should be used to register all new-style IPMI handler
570  * @param handler - the callback function that will handle this request
572  * @return bool - success of registering the handler
574 template <typename Handler>
576                      Handler&& handler)  in registerHandler()  argument
578     auto h = ipmi::makeHandler(std::forward<Handler>(handler));  in registerHandler()
583  * @brief register a IPMI OEM group handler
603  * @tparam Handler - implicitly specified callback function type
608  * @param handler - the callback function that will handle this request
610  * @return bool - success of registering the handler
613 template <typename Handler>
615                           Handler&& handler)  in registerGroupHandler()  argument
617     auto h = ipmi::makeHandler(handler);  in registerGroupHandler()
622  * @brief register a IPMI OEM IANA handler
638  * @tparam Handler - implicitly specified callback function type
643  * @param handler - the callback function that will handle this request
645  * @return bool - success of registering the handler
648 template <typename Handler>
650                         Handler&& handler)  in registerOemHandler()  argument
652     auto h = ipmi::makeHandler(handler);  in registerOemHandler()
660  * @brief legacy IPMI handler registration function
662  * This function should be used to register all legacy IPMI handler
664  * mechanism did, silently replacing any existing handler with a new one.
669  * @param handler - the callback function that will handle this request
674                             ipmi_context_t context, ipmid_callback_t handler,