diff options
author | Nikias Bassen | 2010-03-05 16:27:07 +0100 |
---|---|---|
committer | Matt Colyer | 2010-03-08 21:08:07 -0800 |
commit | 77aa0b3c5b4fc6cff147e98a2130dd11204b40ad (patch) | |
tree | fecc02a1721d32a1188dcfd7af8a7601bbc2b63c | |
parent | 32b65dea4abc416320a97b8b7a438b90b2d449b0 (diff) | |
download | libimobiledevice-77aa0b3c5b4fc6cff147e98a2130dd11204b40ad.tar.gz libimobiledevice-77aa0b3c5b4fc6cff147e98a2130dd11204b40ad.tar.bz2 |
notification_proxy: docs updated
-rw-r--r-- | src/notification_proxy.c | 32 | ||||
-rw-r--r-- | src/notification_proxy.h | 2 |
2 files changed, 21 insertions, 13 deletions
diff --git a/src/notification_proxy.c b/src/notification_proxy.c index eb5e6b2..827468e 100644 --- a/src/notification_proxy.c +++ b/src/notification_proxy.c @@ -1,6 +1,6 @@ /* * notification_proxy.c - * Notification Proxy implementation. + * com.apple.mobile.notification_proxy service implementation. * * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. * @@ -35,9 +35,10 @@ struct np_thread { np_notify_cb_t cbfunc; }; -/** Locks an NP client, done for thread safety stuff. +/** + * Locks a notification_proxy client, used for thread safety. * - * @param client The NP + * @param client notification_proxy client to lock */ static void np_lock(np_client_t client) { @@ -45,9 +46,10 @@ static void np_lock(np_client_t client) g_mutex_lock(client->mutex); } -/** Unlocks an NP client, done for thread safety stuff. +/** + * Unlocks a notification_proxy client, used for thread safety. * - * @param client The NP + * @param client notification_proxy client to unlock */ static void np_unlock(np_client_t client) { @@ -81,7 +83,8 @@ static np_error_t np_error(property_list_service_error_t err) return NP_E_UNKNOWN_ERROR; } -/** Makes a connection to the NP service on the phone. +/** + * Connects to the notification_proxy on the specified device. * * @param device The device to connect to. * @param port Destination port (usually given by lockdownd_start_service). @@ -117,9 +120,11 @@ np_error_t np_client_new(idevice_t device, uint16_t port, np_client_t *client) return NP_E_SUCCESS; } -/** Disconnects an NP client from the device. +/** + * Disconnects a notification_proxy client from the device and frees up the + * notification_proxy client data. * - * @param client The client to disconnect. + * @param client The notification_proxy client to disconnect and free. * * @return NP_E_SUCCESS on success, or NP_E_INVALID_ARG when client is NULL. */ @@ -142,7 +147,8 @@ np_error_t np_client_free(np_client_t client) return NP_E_SUCCESS; } -/** Sends a notification to the device's Notification Proxy. +/** + * Sends a notification to the device's notification_proxy. * * @param client The client to send to * @param notification The notification message to send @@ -177,7 +183,8 @@ np_error_t np_post_notification(np_client_t client, const char *notification) return res; } -/** Notifies the device to send a notification on the specified event. +/** + * Tells the device to send a notification on the specified event. * * @param client The client to send to * @param notification The notifications that should be observed. @@ -206,7 +213,8 @@ np_error_t np_observe_notification( np_client_t client, const char *notification return res; } -/** Notifies the device to send a notification on specified events. +/** + * Tells the device to send a notification on specified events. * * @param client The client to send to * @param notification_spec Specification of the notifications that should be @@ -242,7 +250,7 @@ np_error_t np_observe_notifications(np_client_t client, const char **notificatio } /** - * Checks if a notification has been sent. + * Checks if a notification has been sent by the device. * * @param client NP to get a notification from * @param notification Pointer to a buffer that will be allocated and filled diff --git a/src/notification_proxy.h b/src/notification_proxy.h index 6f2dc99..442f5d8 100644 --- a/src/notification_proxy.h +++ b/src/notification_proxy.h @@ -1,6 +1,6 @@ /* * notification_proxy.h - * Notification Proxy header file. + * com.apple.mobile.notification_proxy service header file. * * Copyright (c) 2009 Nikias Bassen, All Rights Reserved. * |