SNIP_CLASSIC_STD_SECTION_5_6_14_Rte_Result

5.6.14 Rte_Result Purpose: Get the result of an asynchronous client-server call. Signature: [SWS_Rte_01111] Upstream requirements: SRS_BSW_00310 ⌈ If returnValueProvision of the related AsynchronousServerCallResultPoint(s) is not set to noReturnValueProvided: Std_ReturnType Rte_[Byps_]Result_<p>_<o>([IN Rte_Instance <instance>], [IN/OUT|OUT <param 1>]... [IN/OUT|OUT <param n>], [OUT Std_TransformerError transformerError]) If returnValueProvision of the related AsynchronousServerCallResultPoint(s) is set to noReturnValueProvided: void Rte_[Byps_]Result_<p>_<o>([IN Rte_Instance <instance>], [IN/OUT|OUT <param 1>]... [IN/OUT|OUT <param n>], [OUT Std_TransformerError transformerError]) Where <p> is the port name and <o> the operation within the client-server interface categorizing the port. [Byps_] is an optional infix used when component wrapper method for bypass support is enabled for the related software component type.⌋ The signature can include zero or more IN/OUT and OUT parameters depending on the signature of the operation in the client-server interface. Existence: [SWS_Rte_01296] Upstream requirements: SRS_Rte_00051 ⌈A non-blocking Rte_Result API shall be generated if an AsynchronousServerCallResultPoint exists for the specific RunnableEntity and this AsynchronousServerCallResultPoint references an AsynchronousServerCallPoint which according to [SWS_Rte_01294] leads to the generation of an asynchronous Rte_Call API but no WaitPoint (of the RunnableEntity) references an AsynchronousServerCallReturnsEvent that references the AsynchronousServerCallResultPoint.⌋ Please note that a non-blocking Rte_Result API does not require the existence of a AsynchronousServerCallReturnsEvent. If the AsynchronousServerCallReturnsEvent exists it can be used to trigger the execution of a RunnableEntity in which the non-blocking Rte_Result API function may be called. [SWS_Rte_01297] Upstream requirements: SRS_Rte_00051 ⌈A blocking Rte_Result API shall be generated if an AsynchronousServerCallResultPoint exists for the specific RunnableEntity and this AsynchronousServerCallResultPoint references an AsynchronousServerCallPoint which according to [SWS_Rte_01294] leads to the generation of an asynchronous Rte_Call API and a WaitPoint (of the RunnableEntity) references an AsynchronousServerCallReturnsEvent that references the AsynchronousServerCallResultPoint.⌋ [SWS_Rte_CONSTR_09025] Blocking Rte_Result API may only be used by the runnable that describe the WaitPoint ⌈The blocking Rte_Result API may only be used by the runnable that contains the corresponding WaitPoint⌋ [SWS_Rte_01298] Upstream requirements: SRS_Rte_00051 ⌈If an AsynchronousServerCallReturnsEvent references a RunnableEntity and a required ClientServerOperation, the RunnableEntity shall be activated when the operation’s result is available or when a timeout was detected by the RTE [SWS_Rte_01133].⌋ Requirement [SWS_Rte_01298] merely affects when the runnable is activated – an API call should still be created to actually read the reply based on requirement [SWS_Rte_01296]. [SWS_Rte_01312] Upstream requirements: SRS_Rte_00051 ⌈An AsynchronousServerCallReturnsEvent that references a runnable entity and is referenced by a WaitPoint is invalid.⌋ [SWS_Rte_08567] Upstream requirements: SRS_Rte_00249 ⌈The optional OUT parameter transformerError of the API shall be generated if the PortPrototype of port <p> is referenced by a PortAPIOption which has the attribute errorHandling set to transformerErrorHandling.⌋ Description: The Rte_Result API is used by a client to collect the result of an asynchronous client-server communication. The Rte_Result API includes zero or more IN/OUT and OUT parameters to pass back results. The pointers to all parameters passed by reference must remain valid until the API call returns. The OUT parameter transformerError contains the transformer error which occured during execution of the transformer chain. See chapter 4.10.5. Return Value: None in case returnValueProvision of the related AsynchronousServerCallResultPoint(s) is set to noReturnValueProvided. Otherwise, the return value is used to indicate errors from either the Rte_Result call itself or communication errors detected before the API call was made. • [SWS_Rte_01112] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_OK – The API call completed successfully.⌋ Note: This means that RTE_E_OK is returned when neither an infrastructure error nor an overlay error occurred at the invocation of the server runnable and the invoked server runnable was returning a value equal to E_OK. • [SWS_Rte_08591] Upstream requirements: SRS_Rte_00094, SRS_Rte_00091 ⌈RTE_E_TRANSFORMER_LIMIT – The RTE is not able to allocate the buffer needed to transform the data.⌋ • [SWS_Rte_08729] Upstream requirements: SRS_Rte_00094, SRS_Rte_00091 ⌈RTE_E_HARD_TRANSFORMER_ERROR – The return value of one transformer in the transformer chain represented a hard transformer error.⌋ • [SWS_Rte_08556] Upstream requirements: SRS_Rte_00094, SRS_Rte_00091 ⌈RTE_E_SOFT_TRANSFORMER_ERROR – The return value of at least one transformer in the transformer chain was a soft error and no hard error occurred in the transformer chain.⌋ • [SWS_Rte_01113] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_NO_DATA – (non-blocking read) The server’s result is not available but no other error occurred within the API call or the server was not called since Rte_Start. The buffers for the IN/OUT and OUT parameters shall not be modified.⌋ • [SWS_Rte_08301] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_NO_DATA – (non-blocking read) The previous Rte_Call returned an RTE_E_SEG_FAULT, RTE_E_TRANSFORMER_LIMIT, RTE_E_HARD_TRANSFORMER_ERROR.⌋ • [SWS_Rte_01114] Upstream requirements: SRS_Rte_00094, SRS_Rte_00069 ⌈RTE_E_TIMEOUT – The server’s result is not available within the specified timeout but no other error occurred within the API call. The buffers for the IN/OUT and OUT parameters shall not be modified.⌋