ooni-probe-cli/pkg/oonimkall
Simone Basso 3b029ee0d6
feat(ExperimentOrchestraClient): add CheckIn (#263)
We use ExperimentOrchestraClient in several places to help us
calling probe-services APIs. We need to call CheckIn because we
want to use CheckIn in InputLoader.

(We also want to remove the URLs API, but that is not something
doable now, since the mobile app is still using this API via
the wrappers at pkg/oonimkall.)

Work part of https://github.com/ooni/probe/issues/1299.
2021-03-25 12:02:02 +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
experiment_test.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
experiment.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
README.md refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
session_integration_test.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
session_test.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
session.go refactor+doc(oonimkall): improve docs and simplify code (#253) 2021-03-11 09:42:23 +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 feat(ExperimentOrchestraClient): add CheckIn (#263) 2021-03-25 12:02:02 +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
webconnectivity_integration_test.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
webconnectivity_test.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00
webconnectivity.go oonimkall: mobile api for running WebConnectivity (#223) 2021-03-18 08:44:58 +01:00

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.