99b28c1d95
* refactor: start building an Android package Part of https://github.com/ooni/probe/issues/1335. This seems also a good moment to move some packages out of the engine, e.g., oonimkall. This package, for example, is a consumer of the engine, so it makes sense it's not _inside_ it. * fix: committed some stuff I didn't need to commit * fix: oonimkall needs to be public to build The side effect is that we will probably need to bump the major version number every time we change one of these APIs. (We can also of course choose to violate the basic guidelines of Go software, but I believe this is bad form.) I have no problem in bumping the major quite frequently and in any case this monorepo solution is convinving me more than continuing to keep a split between engine and cli. The need to embed assets to make the probe more reliable trumps the negative effects of having to ~frequently bump major because we expose a public API. * fix: let's not forget about libooniffi Honestly, I don't know what to do with this library. I added it to provide a drop in replacement for MK but I have no idea whether it's used and useful. I would not feel comfortable exposing it, unlike oonimkall, since we're not using it. It may be that the right thing to do here is just to delete the package and reduce the amount of code we're maintaining? * woops, we're still missing the publish android script * fix(publish-android.bash): add proper API key * ouch fix another place where the name changed
52 lines
1.5 KiB
C
52 lines
1.5 KiB
C
#ifndef INCLUDE_OONIFFI_H_
|
|
#define INCLUDE_OONIFFI_H_
|
|
|
|
#include <stdint.h>
|
|
#include <stdlib.h>
|
|
|
|
/*
|
|
* ABI compatible with Measurement Kit v0.10.11 [1].
|
|
*
|
|
* Just replace `mk_` with `ooniffi_` and recompile.
|
|
*
|
|
* .. [1] https://github.com/measurement-kit/measurement-kit/tree/v0.10.11/
|
|
*
|
|
* This is not used in any OONI product. We may break something
|
|
* in ooniffi without noticing it. Please, be aware of that.
|
|
*/
|
|
|
|
typedef struct ooniffi_task_ ooniffi_task_t;
|
|
typedef struct ooniffi_event_ ooniffi_event_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
extern ooniffi_task_t *ooniffi_task_start(const char *settings);
|
|
extern ooniffi_event_t *ooniffi_task_wait_for_next_event(ooniffi_task_t *task);
|
|
extern int ooniffi_task_is_done(ooniffi_task_t *task);
|
|
extern void ooniffi_task_interrupt(ooniffi_task_t *task);
|
|
extern const char *ooniffi_event_serialization(ooniffi_event_t *str);
|
|
extern void ooniffi_event_destroy(ooniffi_event_t *str);
|
|
extern void ooniffi_task_destroy(ooniffi_task_t *task);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/*
|
|
* Define OONIFFI_EMULATE_MK_API to provide a MK-compatible API at
|
|
* compile time that will map to ooniffi's own API.
|
|
*/
|
|
#ifdef OONIFFI_EMULATE_MK_API
|
|
#define mk_task_start ooniffi_task_start
|
|
#define mk_task_wait_for_next_event ooniffi_task_wait_for_next_event
|
|
#define mk_task_is_done ooniffi_task_is_done
|
|
#define mk_task_interrupt ooniffi_task_interrupt
|
|
#define mk_event_serialization ooniffi_event_serialization
|
|
#define mk_event_destroy ooniffi_event_destroy
|
|
#define mk_task_destroy ooniffi_task_destroy
|
|
#endif
|
|
|
|
#endif /* INCLUDE_OONIFFI_H_ */
|