Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct/clarify TimerEvent::insert documentation #14005

Merged
merged 1 commit into from
Dec 9, 2020

Commits on Dec 7, 2020

  1. Correct/clarify TimerEvent::insert documentation

    There was much confusion over the functionality of the original
    `TimerEvent::insert` call which was described as "Set relative timestamp
    of the internal event".
    
    This then extended to my Chrono conversion, meaning the new `insert`
    call is not equivalent.
    
    Clarify the original documentation, correct the deprecation messages,
    and add more notes on conversion.
    
    No functional change, as the new Chrono API makes more sense - it's just
    different from the old API.
    
    Problem actually spotted when I saw the strange code `convert_timestamp`
    was producing for the 32-bit->64-bit timestamp conversion. The caller of
    it was actually making the mistake of issuing
    "TimerEvent::insert(rel_timeout)`, meaning they'd also misunderstood the
    documentation, and were not getting the timeout they expected.
    
    (Chrono would have prevented that mistake as durations and time points
    are incompatible types).
    kjbracey committed Dec 7, 2020
    Configuration menu
    Copy the full SHA
    cf66a6e View commit details
    Browse the repository at this point in the history