SNIP_CLASSIC_CANTP_SECTION_8_3_5_CanTp_CancelTransmit

8.3.5 CanTp_CancelTransmit [SWS_CanTp_00246] Definition of API function CanTp_CancelTransmit ⌈ Service Name CanTp_CancelTransmit Syntax Std_ReturnType CanTp_CancelTransmit ( PduIdType TxPduId ) Service ID [hex] 0x4a Sync/Async Synchronous Reentrancy Reentrant for different PduIds. Non reentrant for the same PduId. Parameters (in) TxPduId 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 transmission of a PDU in a lower layer communication module. Available via CanTp.h ⌋ This service cancels the transmission of an N-SDU that has already requested for transmission by calling CanTp_Transmit service. [SWS_CanTp_00254] ⌈If development error detection is enabled the function CanTp_CancelTransmit shall check the validity of function parameter TxPduId. If its value is invalid, the CanTp_CancelTransmit function shall raise the development error CANTP_E_INVALID_TX_ID. If the parameter value indicates a cancel transmission request for an N-SDU that it is not on transmission process the CanTp module shall report a runtime error code CANTP_E_OPER_NOT_SUPPORTED to the Default Error Tracer and the service shall return E_NOT_OK.⌋ [SWS_CanTp_00256] ⌈The CanTp shall abort the transmission of the current N-SDU if the service returns E_OK.⌋ [SWS_CanTp_00255] ⌈If the CanTp_CancelTransmit service has been successfully executed the CanTp shall call the PduR_CanTpTxConfirmation with notification result E_NOT_OK.⌋