SNIP_CLASSIC_DCM_SECTION_8_4_1_Dcm_StartOfReception

8.4.1 Dcm_StartOfReception [SWS_Dcm_00094] Definition of callback function Dcm_StartOfReception ⌈ Service Name Dcm_StartOfReception Syntax BufReq_ReturnType Dcm_StartOfReception ( PduIdType id, const PduInfoType* info, PduLengthType TpSduLength, PduLengthType* bufferSizePtr ) Service ID [hex] 0x46 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) id Identification of the I-PDU. ▽ Manager △ info Pointer to a PduInfoType structure containing the payload data (without protocol information) and payload length of the first frame or single frame of a transport protocol I-PDU reception, and the MetaData related to this PDU. If neither first/single frame data nor MetaData are available, this parameter is set to NULL_PTR. TpSduLength Total length of the N-SDU to be received. Parameters (inout) None Parameters (out) bufferSizePtr Available receive buffer in the receiving module. This parameter will be used to compute the Block Size (BS) in the transport protocol module. Return value BufReq_ReturnType BUFREQ_OK: Connection has been accepted. bufferSizePtr indicates the available receive buffer; reception is continued. If no buffer of the requested size is available, a receive buffer size of 0 shall be indicated by bufferSizePtr. BUFREQ_E_NOT_OK: Connection has been rejected; reception is aborted. bufferSizePtr remains unchanged. BUFREQ_E_OVFL: No buffer of the required length can be provided; reception is aborted. bufferSizePtr remains unchanged. Description This function is called at the start of receiving an N-SDU. The N-SDU might be fragmented into multiple N-PDUs (FF with one or more following CFs) or might consist of a single N-PDU (SF). If the service is successful and BUFREQ_OK is returned, the service provides the currently available maximum buffer size. This function might be called in interrupt context. Available via Dcm.h ⌋ By the function Dcm_StartOfReception the receiver (e.g. DCM) is also informed implicitly about a first frame reception or a single frame reception. If the function Dcm_ StartOfReception returns a return value not equal to BUFREQ_OK, the values of the out parameters are not specified and should not be evaluated by the caller.