[PATCH 10/15] service: Document 'service_set_proxy_method'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <[email protected]> |
Add documentation to the 'service_set_proxy_method' function. --- src/service.c | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/src/service.c b/src/service.c index d2d8e7cea065..3fd56188093d 100644 --- a/src/service.c +++ b/src/service.c @@ -5568,6 +5568,41 @@ const char * const *connman_service_get_timeservers(const struct connman_service return (const char * const *)service->timeservers; } +/** + * @brief + * Set the proxy method for the specified service. + * + * This attempts to set the proxy method for the specified + * service. If the service is null or if the service is hidden, no + * action is taken. If specified, a handler will be invoked, with the + * specified context, after setting the proxy method. + * + * If the handler is specified and it returns true, following, a + * D-Bus change notification should be sent for the service "Proxy" + * property and, if requested by @a donotifier, the proxy changed + * notifier chain will be run. + * + * @param[in,out] service A pointer to the mutable network + * service for which to set the proxy + * method. + * @param[in] method The network service proxy method to set + * on @a service. + * @param[in] donotifier A Boolean indicating whether the proxy + * changed notifier chain should be run + * after @a method is set on @a service. + * @param[in] handler An optional pointer to a handler that, + * if specified, will be invoked after @a + * method is set on @a service. + * @param[in] context An optional pointer to immutable context + * that will be passed to @a handler, + * along with @a service and @a method. + * + * @sa __connman_notifier_proxy_changed + * @sa proxy_changed + * + * @private + * + */ static void service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method, bool donotifier, -- 2.45.0