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,  in instanceIdExpiryCallBack()
164             request->stop();  in instanceIdExpiryCallBack()
181             /* try to send new request if the endpoint is free */  in instanceIdExpiryCallBack()
193     /** @brief Send the remaining PLDM request messages in endpoint queue
209         auto request = std::make_unique<RequestInterface>(  in pollEndpointQueue()  local
217         auto rc = request->start();  in pollEndpointQueue()
222 …       "Failure to send the PLDM request message for polling endpoint queue, response code '{RC}'",  in pollEndpointQueue()
244                          std::make_tuple(std::move(request),  in pollEndpointQueue()
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,  in registerRequest()
270                 "Register request for EID '{EID}' is using InstanceID '{INSTANCEID}'",  in registerRequest()
289         /* try to send new request if the endpoint is free */  in registerRequest()
294                 "Failed to process request queue for EID {EID}, response code {RC}.",  in registerRequest()
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];  in unregisterRequest()
320             request->stop();  in unregisterRequest()
332             /* try to send new request if the endpoint is free */  in unregisterRequest()
342 … "Can't find request for EID '{EID}' is using InstanceID '{INSTANCEID}' in Endpoint message Queue",  in unregisterRequest()
347             /* Find the registered request in the requestQueue */  in unregisterRequest()
371      *  @param[in] instanceId - instance ID to match request and response
384             auto& [request, responseHandler, timerInstance] = handlers[key];  in handleResponse()
385             request->stop();  in handleResponse()
398             /* try to send new request if the endpoint is free */  in handleResponse()
410         mctp_eid_t eid, pldm::Request&& request);
419     uint8_t numRetries;               //!< number of request retries
423     /** @brief Container for storing the details of the PLDM request
435     /** @brief Container for storing the PLDM request entries */
438     /** @brief Container to store information about the request entries to be
445     /** @brief Remove request entry for which the instance ID expired
447      *  @param[in] key - key for the Request
465  * @tparam RequestInterface - Request class type
474                                   mctp_eid_t eid, pldm::Request&& request,  in SendRecvMsgOperation()
476         handler(handler), request(std::move(request)), receiver(std::move(r))  in SendRecvMsgOperation()
479             reinterpret_cast<const pldm_msg*>(this->request.data());  in SendRecvMsgOperation()
491      *         If so, it sets the state to stopped.Registers the request with
495      *  @param[in] op - operation request
512             op.requestKey.command, std::move(op.request),  in tag_invoke()
529     /** @brief Unregisters the request and sets the state to stopped on the
562     /** @brief Reference to a Handler object that manages the request/response
567     /** @brief Stores information about the request such as eid, instanceId,
572     /** @brief The request message to be sent.
574     pldm::Request request;  member
576     /** @brief The response message for the sent request message.
580     /** @brief The length of response message for the sent request message.
600  * @tparam RequestInterface - Request class type
610                                mctp_eid_t eid, pldm::Request&& request) :  in SendRecvMsgSender()
611         handler(handler), eid(eid), request(std::move(request))  in SendRecvMsgSender()
620     /** @brief Execute the sending the request message */
625             self.handler, self.eid, std::move(self.request), std::move(r));  in tag_invoke()
629     /** @brief Reference to a Handler object that manages the request/response
634     /** @brief MCTP Endpoint ID of request message */
637     /** @brief Request message */
638     pldm::Request request;  member
644  *  @param[in] request - PLDM request message
653                                            pldm::Request&& request)  in sendRecvMsg()  argument
655     return SendRecvMsgSender(*this, eid, std::move(request)) |  in sendRecvMsg()