872971ed8c
The oonimkall package is only public for technical reasons. We cannot use `go mobile` on a private package. We consider oonimkall our private interface to our mobile apps, thus we reserve the right to change its API without bumping the major number. We'll bump the major number in case of breaking changes in the cmd/ooniprobe CLI interface, or in case of other major improvements that significantly modify cmd/ooniprobe.
Package github.com/ooni/probe-cli/pkg/oonimkall
Package oonimkall implements APIs used by OONI mobile apps. We expose these APIs to mobile apps using gomobile.
We expose two APIs: the task API, which is derived from the
API originally exposed by Measurement Kit, and the session API,
which is a Go API that mobile apps can use via gomobile.
This package is named oonimkall because it contains a partial reimplementation of the mkall API implemented by Measurement Kit in, e.g., mkall-ios.
The basic tenet of the task API is that you define an experiment task you wanna run using a JSON, then you start a task for it, and you receive events as serialized JSONs. In addition to this functionality, we also include extra APIs used by OONI mobile.
The basic tenet of the session API is that you create an instance
of Session and use it to perform the operations you need.