TokTok / toxcore / 222
74%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 85
Run time 6s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
222

Pull #27

travis-ci

web-flow 
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 returns a new user data pointer, which may or may
not be the same as the passed pointer. The returned pointer is then passed to
the next callback, etc. At the end, the pointer is returned by tox_iterate. If
any of the callbacks returns NULL, there is no more user data pointer, so all
callbacks must by default return their argument.

**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 returns the new location from 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.
Pull Request #27: 8. Stateless

8183 of 12510 relevant lines covered (65.41%)

513736.23 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
1
82.21
 -0.34% toxcore/onion.c
1
57.3
 -0.21% toxcore/TCP_client.c
1
88.44
 0.0% toxcore/onion_client.c
1
83.65
 1.01% toxcore/net_crypto.c
1
85.07
 -0.75% toxcore/ping.c
96
60.52
 0.0% toxcore/tox.c
167
77.07
 -0.03% toxcore/Messenger.c
Jobs
ID Job ID Ran Files Coverage
2 222.2 (BUILD=toxcore ENV=linux) 85
65.41
 Travis Job 222.2
Source Files on build 222
Coverage ∆ File Lines Relevant Covered Missed Hits/Line