~connman-maintainers/connman/head

« back to all changes in this revision

Viewing changes to src/service.c

  • Committer: Marcel Holtmann
  • Author(s): Grant Erickson
  • Date: 2023-11-25 16:20:10 UTC
  • Revision ID: git-v1:643a6aa16e6307e08999f6e4238c445d6fdf249d
service: Add documentation to 'address_updated'.

This adds documentation to the 'address_updated' function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2235
2235
                        online_check_connect_timeout_ms, complete_online_check);
2236
2236
}
2237
2237
 
 
2238
/**
 
2239
 *  @brief
 
2240
 *    Handle an update to the address(es) for the specified network
 
2241
 *    service and IP configuration type.
 
2242
 *
 
2243
 *  This attempts to handle an address change or update for the
 
2244
 *  specified network service and IP configuration type if and only if
 
2245
 *  it is connected (that is, #is_connected returns true) and it is
 
2246
 *  the default service (that is, has the default route).
 
2247
 *
 
2248
 *  If the service meets those criteria, then nameservers are
 
2249
 *  refreshed, an "online" HTTP-based Internet reachability check is
 
2250
 *  initiated, and a time-of-day synchronization is requested.
 
2251
 *
 
2252
 *  @param[in,out]  service  A pointer to the mutable network service
 
2253
 *                           for which there was an address change or
 
2254
 *                           update.
 
2255
 *  @param[in]      type     The IP configuration type for @a service
 
2256
 *                           for which there was an address change or
 
2257
 *                           update.
 
2258
 *
 
2259
 *  @sa nameserver_remove_all
 
2260
 *  @sa nameserver_add_all
 
2261
 *  @sa start_online_check
 
2262
 *  @sa __connman_timeserver_sync
 
2263
 *
 
2264
 */
2238
2265
static void address_updated(struct connman_service *service,
2239
2266
                        enum connman_ipconfig_type type)
2240
2267
{