SNIP_CLASSIC_STD_SECTION_5_6_13_Rte_Call

5.6.13 Rte_Call Purpose: Initiate a client-server communication. Signature: [SWS_Rte_01102] Upstream requirements: SRS_BSW_00310, SRS_Rte_00029 ⌈ If returnValueProvision of the related ServerCallPoint(s) is not set to noReturnValueProvided: Std_ReturnType Rte_[Byps_]Call_<p>_<o>([IN Rte_Instance <instance>], [IN|IN/OUT|OUT] <data_1>... [IN|IN/OUT|OUT] <data_n>, [OUT Std_TransformerError transformerError]) If returnValueProvision of the related ServerCallPoint(s) is set to noReturnValueProvided: void Rte_[Byps_]Call_<p>_<o>([IN Rte_Instance <instance>], [IN|IN/OUT|OUT] <data_1>... [IN|IN/OUT|OUT] <data_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.⌋ Existence: [SWS_Rte_01293] Upstream requirements: SRS_Rte_00051, SRS_Rte_00111 ⌈A synchronous Rte_Call API shall be generated if a SynchronousServerCallPoint references a required ClientServerOperation.⌋ [SWS_Rte_01294] Upstream requirements: SRS_Rte_00051, SRS_Rte_00111 ⌈An asynchronous Rte_Call API shall be generated if an AsynchronousServerCallPoint references a required ClientServerOperation.⌋ A configuration that includes both synchronous and asynchronous ServerCallPoints for a given ClientServerOperation is invalid ([SWS_Rte_03014]). [SWS_Rte_CONSTR_09024] Rte_Call API may only be used by the runnable that describe its usage ⌈The Rte_Call API may only be used by the runnable that contains the corresponding ServerCallPoint⌋ [SWS_Rte_08566] 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: Client function to initiate client-server communication. The Rte_Call API is used for both synchronous and asynchronous calls. The Rte_Call API includes zero or more IN, IN/OUT and OUT parameters. [SWS_Rte_06639] Upstream requirements: SRS_Rte_00051, SRS_Rte_00111 ⌈IN/OUT parameters are passed by value when they are "Primitive Implementation Data Type"s and the call is asynchronous.⌋ Rational: In case of an asynchronous call, the IN/OUT parameters are only IN parameters. The IN, IN/OUT and OUT parameters are passed by value or reference according to the ImplementationDataType as described in the section 5.2.6.5. 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 ServerCallPoint(s) is set to noReturnValueProvided. Otherwise: [SWS_Rte_01103] Upstream requirements: SRS_Rte_00094, SRS_Rte_00123, SRS_Rte_ 00124 ⌈The return value shall be used to indicate infrastructure errors detected by the RTE during execution of the Rte_Call call and, for synchronous communication, infrastructure and application errors during execution of the server.⌋ • [SWS_Rte_01104] 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_01105] Upstream requirements: SRS_Rte_00094, SRS_Rte_00079 ⌈RTE_E_LIMIT – The client has multiple outstanding asynchronous client-server invocations of the same operation in the same port. The server invocation shall be discarded, the buffers of the return parameters shall not be modified (see also [SWS_Rte_02658]).⌋ • [SWS_Rte_08727] 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_08728] 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_08555] 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_01106] Upstream requirements: SRS_Rte_00094 ⌈RTE_E_COM_STOPPED – the RTE could not perform the operation because the communication service is currently not available (inter ECU communication only). RTE shall return RTE_E_COM_STOPPED when: – in case of COM the corresponding service returns COM_SERVICE_NOT_AVAILABLE – in case of Large Data Path in COM the corresponding Com_Transmit returns E_NOT_OK The buffers of the return parameters shall not be modified.⌋ • [SWS_Rte_01107] Upstream requirements: SRS_Rte_00094, SRS_Rte_00069 ⌈RTE_E_TIMEOUT – (synchronous inter-task and inter-ECU only) No reply was received within the configured timeout. The buffers of the return parameters shall not be modified.⌋ • RTE_E_UNCONNECTED – Indicates that the client port is not connected [SWS_Rte_01334]. • [SWS_Rte_02744] Upstream requirements: SRS_Rte_00092, SRS_Rte_00046, SRS_Rte_00032 ⌈RTE_E_IN_EXCLUSIVE_AREA – Used only for the blocking API. RTE_E_IN_EXCLUSIVE_AREA indicates that the runnable can not enter wait, as one of the ExecutableEntitys in the call stack of this task is currently in an exclusive area, see [SWS_Rte_02739]. - In a properly configured system, this error should not occur. The check can be disabled according to [SWS_Rte_08321].⌋