diff options
author | Nikias Bassen | 2022-05-09 13:03:01 +0200 |
---|---|---|
committer | Nikias Bassen | 2022-05-09 13:03:01 +0200 |
commit | 2b48c417c5b4f2fa78ab0960eb718ff081fa48e6 (patch) | |
tree | d06e9df1772236a571251797a7e0e92f48ae20bb /include | |
parent | cad15f71204f32a389bee2797be22f84e7480f58 (diff) | |
download | libimobiledevice-2b48c417c5b4f2fa78ab0960eb718ff081fa48e6.tar.gz libimobiledevice-2b48c417c5b4f2fa78ab0960eb718ff081fa48e6.tar.bz2 |
Add new idevice_events_subscribe/unsubscribe API with context
The older API idevice_event_subscribe/unsubscribe can only be used
by a single instance. With the addition of a context, is is now possible
to register multiple callback functions in different threads.
For backwards compatibility the old API will still be available for a while
before being removed in a future release.
Diffstat (limited to 'include')
-rw-r--r-- | include/libimobiledevice/libimobiledevice.h | 36 |
1 files changed, 34 insertions, 2 deletions
diff --git a/include/libimobiledevice/libimobiledevice.h b/include/libimobiledevice/libimobiledevice.h index c3b87cd..6851145 100644 --- a/include/libimobiledevice/libimobiledevice.h +++ b/include/libimobiledevice/libimobiledevice.h @@ -94,6 +94,9 @@ typedef struct { /** Callback to notifiy if a device was added or removed. */ typedef void (*idevice_event_cb_t) (const idevice_event_t *event, void *user_data); +/** Event subscription context type */ +typedef struct idevice_subscription_context* idevice_subscription_context_t; + /* functions */ /** @@ -104,9 +107,36 @@ typedef void (*idevice_event_cb_t) (const idevice_event_t *event, void *user_dat void idevice_set_debug_level(int level); /** - * Register a callback function that will be called when device add/remove + * Subscribe a callback function that will be called when device add/remove * events occur. * + * @param context A pointer to a idevice_subscription_context_t that will be + * set upon creation of the subscription. The returned context must be + * passed to idevice_events_unsubscribe() to unsubscribe the callback. + * @param callback Callback function to call. + * @param user_data Application-specific data passed as parameter + * to the registered callback function. + * + * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. + */ +idevice_error_t idevice_events_subscribe(idevice_subscription_context_t *context, idevice_event_cb_t callback, void *user_data); + +/** + * Unsubscribe the event callback function that has been registered with + * idevice_events_subscribe(). + * + * @param context A valid context as returned from idevice_events_subscribe(). + * + * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. + */ +idevice_error_t idevice_events_unsubscribe(idevice_subscription_context_t context); + +/** + * (DEPRECATED) Register a callback function that will be called when device add/remove + * events occur. + * + * @deprecated Use idevice_events_subscribe() instead. + * * @param callback Callback function to call. * @param user_data Application-specific data passed as parameter * to the registered callback function. @@ -116,9 +146,11 @@ void idevice_set_debug_level(int level); idevice_error_t idevice_event_subscribe(idevice_event_cb_t callback, void *user_data); /** - * Release the event callback function that has been registered with + * (DEPRECATED) Release the event callback function that has been registered with * idevice_event_subscribe(). * + * @deprecated Use idevice_events_unsubscribe() instead. + * * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. */ idevice_error_t idevice_event_unsubscribe(void); |