Generation of code for functions with timeout in method signatures

[pavelkaryukov]

Is it possible to generate functions with a "timeout" argument? Please provide an example of an XML file.

[pavelkaryukov]

function example

    std::string SetConfig(const std::string& mml, std::uint64_t timeout)
    {
        using namespace std::chrono_literals;
        std::string result;   
 m_proxy.callMethod("SetConfig").onInterface(INTERFACE_NAME).withTimeout(timeout).withArguments(mml).storeResultsTo(result);
        return result;
    }

[sangelovic]

Please, in the future, open a discussion instead of an issue if you simply have a question. GitHub issues are intended for sdbus-c++ issues/problems/bugs, not your issues/problems/bugs.

Is it possible to generate functions with a "timeout" argument?

No. Not the way you showed in your example. Timeouts in XMLs are supported by sdbus-c++ XML layer in the way described here: https://github.com/Kistler-Group/sdbus-cpp/blob/master/docs/using-sdbus-c%2B%2B.md#method-call-timeout. You have to know the timeout value at design time; it's hardcoded into the API XML.

However, as you can see, you can configure timeouts if you used the high-level, convenience API directly.

Extending sdbus-c++ to support your case would need to extend the XML with other very sdbus-c++-specific annotation, something like <annotation name="org.freedesktop.DBus.Method.ParamAsTimeout" value="timeout"/>, so the code generator knows this is not real method parameter but a timeout. Fortunately, we would need to extend the codegen tool code only. However, it appears to me as a very specific requirement, which I'm not convinced has the value-cost proposition. But if you submit a PR with this extension, I will review and not block it from being adopted eventually.

Let me know what you think.

[pavelkaryukov]

Thank you for your reply. Apologies for the ISSUE. I added generation of functions with timeout parameters in the signature. Pr #510

[pavelkaryukov]

@sangelovic, gentle ping

[sangelovic]

Will come back to this soon :-)