Callback Deregistration

[forwardpointer]

Type

• Bug fix
• Feature addition
• Feature update
• Breaking change
• Non-functional change
• Documentation
• Infrastructure

Goals

Allow the deregistration of callbacks

Technical Details

• Every callback has an id, this map is stored in m_[session|device]EventCallbacksIdMap.
• m_[session|device]EventCallbacks now stores the callback ids, not the callbacks themselves.
• m_tokens holds the list of tokens so that the memory is not released when we return the tokens to the caller of the register callback functions

Test Results

• the basic ranging scenario works

Reviewer Focus

Currently the interface maintains the invariant that m_tokens, m_[session|device]EventCallbacks, and m_[session|device]EventCallbacksIdMap are always in sync. However, this may result in a slow runtime for GetResolved[Session|Device]EventCallbacks(). Consider if relaxing that invariant makes sense.

Future Work

Checklist

• Build target all compiles cleanly.
• clang-format and clang-tidy deltas produced no new output.
• Newly added functions include doxygen-style comment block.

[abeltrano]

Just a few small suggestions and nit picks, but this is completely awesome 💯

[corbin-phipps]

Still some minor changes that could be made (such as changing return type of InsertDeviceEventCallback to std::weak_ptr), but nothing that affects functionality, so it seems good to go