pldm/requester/handler.hpp

6 #include "request.hpp"
35  *  RequestKey uniquely identifies the PLDM request message to match it with the
72  *  The response when registers PLDM request message using the SendRecvMsg
83  *  This struct is used to store the registered request to one endpoint.
88     std::vector<uint8_t> reqMsg;     //!< Request messages queue
94  *  This struct is used to save the list of request messages of one endpoint and
95  *  the existing of the request message to the endpoint with its' EID.
111  *  This class handles the lifecycle of the PLDM request message based on the
112  *  instance ID expiration interval, number of request retries and the timeout
118  * @tparam RequestInterface - Request class type
138      *  @param[in] numRetries - number of request retries
162             auto& [request, responseHandler,
164             request->stop();
181             /* try to send new request if the endpoint is free */
193     /** @brief Send the remaining PLDM request messages in endpoint queue
209         auto request = std::make_unique<RequestInterface>(
217         auto rc = request->start();
222                 "Failure to send the PLDM request message for polling endpoint queue, response code '{RC}'",
244                          std::make_tuple(std::move(request),
250     /** @brief Register a PLDM request message
253      *  @param[in] instanceId - instance ID to match request and response
256      *  @param[in] requestMsg - PLDM request message
257      *  @param[in] responseHandler - Response handler for this request
262                         uint8_t command, pldm::Request&& requestMsg,
270                 "Register request for EID '{EID}' is using InstanceID '{INSTANCEID}'",
289         /* try to send new request if the endpoint is free */
294                 "Failed to process request queue for EID {EID}, response code {RC}.",
302     /** @brief Unregister a PLDM request message
305      *  @param[in] instanceId - instance ID to match request and response
319             auto& [request, responseHandler, timerInstance] = handlers[key];
320             request->stop();
332             /* try to send new request if the endpoint is free */
342                     "Can't find request for EID '{EID}' is using InstanceID '{INSTANCEID}' in Endpoint message Queue",
347             /* Find the registered request in the requestQueue */
371      *  @param[in] instanceId - instance ID to match request and response
384             auto& [request, responseHandler, timerInstance] = handlers[key];
385             request->stop();
398             /* try to send new request if the endpoint is free */
403             // Got a response for a PLDM request message not registered with the
404             // request handler, so freeing up the instance ID, this can be other
418         mctp_eid_t eid, pldm::Request&& request);
427     uint8_t numRetries;               //!< number of request retries
431     /** @brief Container for storing the details of the PLDM request
443     /** @brief Container for storing the PLDM request entries */
446     /** @brief Container to store information about the request entries to be
453     /** @brief Remove request entry for which the instance ID expired
455      *  @param[in] key - key for the Request
473  * @tparam RequestInterface - Request class type
482                                   mctp_eid_t eid, pldm::Request&& request,
484         handler(handler), request(std::move(request)), receiver(std::move(r))
487             reinterpret_cast<const pldm_msg*>(this->request.data());
499      *         If so, it sets the state to stopped.Registers the request with
503      *  @param[in] op - operation request
520             op.requestKey.command, std::move(op.request),
537     /** @brief Unregisters the request and sets the state to stopped on the
570     /** @brief Reference to a Handler object that manages the request/response
575     /** @brief Stores information about the request such as eid, instanceId,
580     /** @brief The request message to be sent.
582     pldm::Request request;
584     /** @brief The response message for the sent request message.
588     /** @brief The length of response message for the sent request message.
608  * @tparam RequestInterface - Request class type
618                                mctp_eid_t eid, pldm::Request&& request) :
619         handler(handler), eid(eid), request(std::move(request))
628     /** @brief Execute the sending the request message */
633             self.handler, self.eid, std::move(self.request), std::move(r));
637     /** @brief Reference to a Handler object that manages the request/response
642     /** @brief MCTP Endpoint ID of request message */
645     /** @brief Request message */
646     pldm::Request request;
652  *  @param[in] request - PLDM request message
661                                            pldm::Request&& request)
663     return SendRecvMsgSender(*this, eid, std::move(request)) |