History

Simone Basso 26d807c50f fix: always use probe-cli version (and make it alpha) (#219 ) See https://github.com/ooni/probe-engine/issues/1181 While there, run `go fmt ./...`		2021-02-04 11:00:27 +01:00
..
internal/tasks	fix: always use probe-cli version (and make it alpha) (#219 )	2021-02-04 11:00:27 +01:00
.gitignore	refactor: we don't wanna export pkg/oonimkall/tasks (#216 )	2021-02-03 19:48:23 +01:00
README.md	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
session_integration_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
session_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
session.go	fix: always use probe-cli version (and make it alpha) (#219 )	2021-02-04 11:00:27 +01:00
sessioncontext_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
sessioncontext.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
sessionlogger_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
sessionlogger.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
task_integration_test.go	refactor: we don't wanna export pkg/oonimkall/tasks (#216 )	2021-02-03 19:48:23 +01:00
task_internal_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
task.go	refactor: we don't wanna export pkg/oonimkall/tasks (#216 )	2021-02-03 19:48:23 +01:00
uuid_test.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00
uuid.go	refactor: start building an Android package (#205 )	2021-02-03 10:51:14 +01:00

README.md

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.