summaryrefslogtreecommitdiff
path: root/toxcore/tox.c
diff options
context:
space:
mode:
authoriphydf <iphydf@users.noreply.github.com>2016-08-10 13:46:04 +0100
committeriphydf <iphydf@users.noreply.github.com>2016-08-17 14:57:20 +0100
commitdd8a568141b43546521ca438d861e00c26051f6c (patch)
tree98f3f9a871f164b20693eca89eb0c8bf2ae826ed /toxcore/tox.c
parentcebf64a588039c202880659a85d070126bcc68da (diff)
Make self_connection_status callback stateless.
**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.
Diffstat (limited to 'toxcore/tox.c')
-rw-r--r--toxcore/tox.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/toxcore/tox.c b/toxcore/tox.c
index b642db75..4708bc97 100644
--- a/toxcore/tox.c
+++ b/toxcore/tox.c
@@ -390,10 +390,10 @@ TOX_CONNECTION tox_self_get_connection_status(const Tox *tox)
390} 390}
391 391
392 392
393void tox_callback_self_connection_status(Tox *tox, tox_self_connection_status_cb *function, void *user_data) 393void tox_callback_self_connection_status(Tox *tox, tox_self_connection_status_cb *function)
394{ 394{
395 Messenger *m = tox; 395 Messenger *m = tox;
396 m_callback_core_connection(m, function, user_data); 396 m_callback_core_connection(m, function);
397} 397}
398 398
399uint32_t tox_iteration_interval(const Tox *tox) 399uint32_t tox_iteration_interval(const Tox *tox)
@@ -402,10 +402,10 @@ uint32_t tox_iteration_interval(const Tox *tox)
402 return messenger_run_interval(m); 402 return messenger_run_interval(m);
403} 403}
404 404
405void tox_iterate(Tox *tox) 405void tox_iterate(Tox *tox, void *userdata)
406{ 406{
407 Messenger *m = tox; 407 Messenger *m = tox;
408 do_messenger(m); 408 do_messenger(m, userdata);
409 do_groupchats(m->group_chat_object); 409 do_groupchats(m->group_chat_object);
410} 410}
411 411