SNIP_CLASSIC_STD_SECTION_8_5_4_5_IocReceiveGroup_IocReadGroup

8.5.4.5 IocReceiveGroup/IocReadGroup The IocReadGroup API call is generated for "data" and the IocReceiveGroup API call is generated for "events". [SWS_Os_00746] Definition of API function IocReceiveGroup_<IocId> Upstream requirements: SRS_Os_80020 ⌈ Service Name IocReceiveGroup_<IocId> Syntax Std_ReturnType IocReceiveGroup_<IocId> ( <Data1> OUT1, [uint16* numberOfBytesOUT1], <Data2> OUT2, [uint16* numberOfBytesOUT2], ... ) Service ID [hex] 0x24 Sync/Async Synchronous Reentrancy This function is generated individually for each receiver. The individual function is not reentrant (if called from different runnable entities that belong to the same receiver), but different functions can be called in parallel. Parameters (in) None Parameters (inout) None OUT1 List of data references to be filled with the received data elements. The specified order of the parameter shall match to the specified order in the corresponding send function. numberOfBytesOUT1 (optional) data reference to be filled with the length of the received data element (OUT1) in bytes. OUT2 – numberOfBytesOUT2 – Parameters (out) – Return value Std_ReturnType IOC_E_OK: Data was received successfully IOC_E_NO_DATA: No data is available for reception. IOC_E_LOST_DATA: This Overlayed Error indicates that the IOC communication service refused an IOCSend request from sender due to an internal buffer overflow. There is no error in the data returned in parameter. ▽ △ Description Performs an "explicit" sender-receiver transmission of data elements with "event" semantic for a unidirectional 1:1 communication between OS-Applications located on the same or on different cores. This API involves a group of data elements which values are specified in parameter. <IocId> is a unique identifier that references a unidirectional 1:1 communication involving many data elements. Available via Ioc.h ⌋ [SWS_Os_91006] Definition of API function IocReadGroup_<IocId> Upstream requirements: SRS_Os_80020 ⌈ Service Name IocReadGroup_<IocId> Syntax Std_ReturnType IocReadGroup_<IocId> ( <Data1> OUT1, [uint16* numberOfBytesOUT1], <Data2> OUT2, [uint16* numberOfBytesOUT2], ... ) Service ID [hex] 0x25 Sync/Async Synchronous Reentrancy This function is generated individually for each receiver. The individual function is not reentrant (if called from different runnable entities that belong to the same receiver), but different functions can be called in parallel. Parameters (in) None Parameters (inout) None OUT1 List of data references to be filled with the received data elements. The specified order of the parameter shall match to the specified order in the corresponding send function. numberOfBytesOUT1 (optional) data reference to be filled with the length of the received data element (OUT1) in bytes. OUT2 – numberOfBytesOUT2 – Parameters (out) – Return value Std_ReturnType IOC_E_OK: Data was received successfully Description Performs an "explicit" sender-receiver transmission of data elements with a "data" semantic for a unidirectional 1:1 communication between OS-Applications located on the same or on different cores. This API involves a group of data elements which values are specified in parameter. <IocId> is a unique identifier that references a unidirectional 1:1 communication involving many data elements. Available via Ioc.h ⌋ General: [SWS_Os_00747] Upstream requirements: SRS_Os_80020 ⌈A successful call to the IocReceiveGroup/IocReadGroup function indicates that data has been received successfully in the given parameters. The IocReceiveGroup/IocReadGroup function has to be generated in case of intra-core and inter-core communication.⌋ [SWS_Os_00748] Upstream requirements: SRS_Os_80020 ⌈If the OsIocReceiverPullCB attribute is defined with a callback function name, the IOC shall call this function on the receiving core for each data transmission.⌋ Parameters: [SWS_Os_00749] Upstream requirements: SRS_Os_80020 ⌈In case of "data" semantic the IocReadGroup function shall always be able to deliver the last available datum.⌋ [SWS_Os_00750] Upstream requirements: SRS_Os_80020 ⌈The IocReceiveGroup/IocReadGroup function shall guarantee upon returning from execution that the references given in parameters are safe for use.⌋ [SWS_Os_00804] Upstream requirements: SRS_Os_80020 ⌈The OUT <DataN> parameters of the IocReceiveGroup/ IocReadGroup function shall be passed as pointer to the array base type for arrays and by references for all other types.⌋ Returned values: [SWS_Os_00751] Upstream requirements: SRS_Os_80020 ⌈The IocReceiveGroup/IocReadGroup function shall return IOC_E_OK if the data was received successfully in the list of references given in parameter.⌋ [SWS_Os_00752] Upstream requirements: SRS_Os_80020 ⌈In case of "event" semantic and if no data is available the function IocReceiveGroup shall return IOC_E_NO_DATA.⌋ [SWS_Os_00753] Upstream requirements: SRS_Os_80020 ⌈In case of "event" semantic an IOC_E_LOST_DATAOverlayed Error shall be returned by the IocReceiveGroup function if the IOC communication service refused an IocSendGroup request from sender due to an internal buffer overflow. There is no error in the data returned in parameter.⌋