Home | History | Annotate | Line # | Download | only in ServiceRegistration 
      1 /* service-tracker.h
      2  *
      3  * Copyright (c) 2023 Apple Inc. All rights reserved.
      4  *
      5  * Licensed under the Apache License, Version 2.0 (the "License");
      6  * you may not use this file except in compliance with the License.
      7  * You may obtain a copy of the License at
      8  *
      9  *     https://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  *
     17  * This file contains general support definitions for the Off-Mesh Routable
     18  * (OMR) prefix publisher state machine.
     19  */
     20 
     21 #ifndef __SERVICE_TRACKER_H__
     22 #define __SERVICE_TRACKER_H__ 1
     23 
     24 typedef struct service_tracker_callback service_tracker_callback_t;
     25 typedef struct service_tracker service_tracker_t;
     26 typedef struct srp_server_state srp_server_t;
     27 
     28 RELEASE_RETAIN_DECLS(service_tracker);
     29 #define service_tracker_retain(watcher) service_tracker_retain_(watcher, __FILE__, __LINE__)
     30 #define service_tracker_release(watcher) service_tracker_release_(watcher, __FILE__, __LINE__)
     31 void service_tracker_stop(service_tracker_t *NONNULL tracker);
     32 void service_tracker_cancel(service_tracker_t *NONNULL tracker);
     33 bool service_tracker_local_service_seen(service_tracker_t *NONNULL tracker);
     34 service_tracker_t *NULLABLE service_tracker_create(srp_server_t *NONNULL route_state);
     35 void service_tracker_set_reconnect_callback(service_tracker_t *NONNULL tracker,
     36 										  void (*NULLABLE reconnect_callback)(void *NULLABLE context));
     37 void service_tracker_start(service_tracker_t *NONNULL tracker);
     38 bool service_tracker_callback_add(service_tracker_t *NONNULL tracker, void (*NONNULL callback)(void *NULLABLE context),
     39 								  void (*NULLABLE context_release)(void *NULLABLE context), void *NULLABLE context);
     40 void service_tracker_callback_cancel(service_tracker_t *NONNULL tracker, void *NONNULL context);
     41 thread_service_t *NULLABLE service_tracker_services_get(service_tracker_t *NULLABLE tracker);
     42 void service_tracker_thread_service_note(service_tracker_t *NONNULL tracker,
     43                                          thread_service_t *NONNULL service,
     44                                          const char *NONNULL event_description);
     45 bool service_tracker_verified_service_still_exists(service_tracker_t *NULLABLE tracker,
     46                                                    thread_service_t *NULLABLE old_service);
     47 thread_service_t *NULLABLE service_tracker_verified_service_get(service_tracker_t *NULLABLE tracker);
     48 thread_service_t *NULLABLE service_tracker_unverified_service_get(service_tracker_t *NULLABLE tracker,
     49                                                                   thread_service_type_t service_type);
     50 void service_tracker_verify_next_service(service_tracker_t *NULLABLE tracker);
     51 void service_tracker_cancel_probes(service_tracker_t *NULLABLE tracker);
     52 #endif // __SERVICE_TRACKER_H__
     53 
     54 // Local Variables:
     55 // mode: C
     56 // tab-width: 4
     57 // c-file-style: "bsd"
     58 // c-basic-offset: 4
     59 // fill-column: 120
     60 // indent-tabs-mode: nil
     61 // End:
     62