SNIP_CLASSIC_CANTP_SECTION_8_3_6_CanTp_CancelReceive

8.3.6 CanTp_CancelReceive [SWS_CanTp_00257] Definition of API function CanTp_CancelReceive ⌈ Service Name CanTp_CancelReceive Syntax Std_ReturnType CanTp_CancelReceive ( PduIdType RxPduId ) Service ID [hex] 0x4c Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) RxPduId Identification of the PDU to be cancelled. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Cancellation was executed successfully by the destination module. E_NOT_OK: Cancellation was rejected by the destination module. Description Requests cancellation of an ongoing reception of a PDU in a lower layer transport protocol module. Available via CanTp.h ⌋ The service CanTp_CancelReceive cancels the reception of an N-SDU initiated by the reception of a First Frame and consequently calls of PduR_StartOfReception. When the function returns, no reception is in progress anymore with the given N-SDU identifier. [SWS_CanTp_00260] ⌈If development error detection is enabled the function CanTp_CancelReceive shall check the validity of function parameter RxPduId. If its value is invalid, the CanTp_CancelReceive function shall raise the development error CANTP_E_INVALID_RX_ID. If the parameter value indicates a cancel reception request for an N-SDU that it is not on reception process the CanTp module shall report the runtime error code CANTP_ E_OPER_NOT_SUPPORTED to the Default Error Tracer and the service shall return E_NOT_OK.⌋ [SWS_CanTp_00261] ⌈The CanTp shall abort the reception of the current N-SDU if the service returns E_OK.⌋ [SWS_CanTp_00262] ⌈The CanTp shall reject the request for receive cancellation in case of a Single Frame reception or if the CanTp is in the process of receiving the last Consecutive Frame of the N-SDU (i.e. the service is called after N-Cr timeout is started for the last Consecutive Frame). In this case the CanTp shall return E_NOT_OK.⌋ [SWS_CanTp_00263] ⌈If the CanTp_CancelReceive service has been successfully executed the CanTp shall call the PduR_CanTpRxIndication with notification result E_NOT_OK.⌋