search

smartdevicelink / sdl_requirements

Collection of requirements/technical tasks for new sdl_core features
BSD 3-Clause "New" or "Revised" License
2 stars 7 forks source link

[BC.OnResetTimeout] - Restructuring OnResetTimeout #112

Open KhrystynaDubovyk opened 5 years ago

KhrystynaDubovyk commented 5 years ago

OnResetTimeout

Description:

OnResetTimeout notification should be applicable for all interfaces and HMI should send this RPC in case it needs more time to process a request received from SDL.

Detailed description:

OnResetTimeout function definition would be as follows for the BasicCommunication:

<function name="OnResetTimeout" messagetype="notification" since="X.Y">
    <description>
        HMI must send this notification to SDL for method instance for which timeout needs to be reset
    </description>  
    <param name="requestID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">  
        <description>
            Id between HMI and SDL which SDL used to send the request for method in question, for which timeout needs to be reset.
        </description>
    </param>
    <param name="methodName" type="String" mandatory="true">
        <description>
            Name of the function for which timeout needs to be reset
        </description>
    </param>
    <param name="resetPeriod" type="Integer" minvalue="0" maxvalue="1000000" mandatory="false">
        <description>
            Timeout period in milliseconds, for the method for which timeout needs to be reset.
            If omitted, timeout would be reset by defaultTimeout specified in smartDeviceLink.ini
        </description>
    </param>
</function>

Diagram:

N/A

Links: