forked from irungentoo/toxcore
-
Notifications
You must be signed in to change notification settings - Fork 291
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
Stateless callbacks in toxcore's public API #40
Labels
Milestone
Comments
iphydf
added a commit
to iphydf/c-toxcore
that referenced
this issue
Aug 17, 2016
See TokTok#40 for details.
iphydf
added a commit
to iphydf/c-toxcore
that referenced
this issue
Aug 18, 2016
See TokTok#40 for details.
iphydf
added a commit
to iphydf/c-toxcore
that referenced
this issue
Aug 18, 2016
See TokTok#40 for details.
This was referenced Aug 21, 2016
Closed
iphydf
added a commit
to iphydf/c-toxcore
that referenced
this issue
Sep 6, 2016
See TokTok#40 for details.
All planned toxcore callbacks are now stateless. Still left to do are the toxav callbacks. @mannol and/or @cleverca22, who wants to take them on? |
Merged
This was referenced Oct 24, 2016
Closed
Stateless is done? |
Only in toxcore, stateless in toxav was reverted because it introduced a bug. See #203. |
iphydf
changed the title
Stateless callbacks
Stateless callbacks in toxcore's public API
Nov 2, 2016
Closing this, as the toxcore callbacks are done. We are tracking toxav progress in #203. |
zugz
pushed a commit
to zugz/c-toxcore
that referenced
this issue
Jan 2, 2018
…x_05 formatting corrected
iphydf
added
refactor
Refactoring production code, eg. renaming a variable, not affecting semantics
and removed
code cleanup
labels
May 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What are we doing?
We are moving towards stateless callbacks. This means that when registering a
callback, you no longer pass a user data pointer. Instead, you pass a user data
pointer to tox_iterate. This pointer is threaded through the code, passed to
each callback. The callback can modify the data pointed at. An extra indirection
will be needed if the pointer itself can change.
Why?
Currently, callbacks are registered with a user data pointer. This means the
library has N pointers for N different callbacks. These pointers need to be
managed by the client code. Managing the lifetime of the pointee can be
difficult. In C++, it takes special effort to ensure that the lifetime of user
data extends at least beyond the lifetime of the Tox instance. For other
languages, the situation is much worse. Java and other garbage collected
languages may move objects in memory, so the pointers are not stable. Tox4j goes
through a lot of effort to make the Java/Scala user experience a pleasant one by
keeping a global array of Tox+userdata on the C++ side, and communicating via
protobufs. A Haskell FFI would have to do similarly complex tricks.
Stateless callbacks ensure that a user data pointer only needs to live during a
single function call. This means that the user code (or language runtime) can
move the data around at will, as long as it sets the new location in the
callback.
How?
We are doing this change one callback at a time. After each callback, we ensure
that everything still works as expected. This means the toxcore change will
require 15 Pull Requests.
The text was updated successfully, but these errors were encountered: