Add top-level docs and update README

[netwatcher] / src / watch_mac.rs

diff --git a/src/watch_mac.rs b/src/watch_mac.rs
index 7a984e5185c79d6379b4b7e1fd9589ca1c56f5ca..c44169cf25a28b9fc937ecafd3865bc2e76bba35 100644 (file)
--- a/src/watch_mac.rs
+++ b/src/watch_mac.rs
@@ -8,38 +8,45 @@ use crate::{Error, List, Update};
 // The "objc2" project aims to provide bindings for all frameworks but Network.framework
 // isn't ready yet so let's kick it old-school
 
 // The "objc2" project aims to provide bindings for all frameworks but Network.framework
 // isn't ready yet so let's kick it old-school
 

-struct nw_path_monitor;
-type nw_path_monitor_t = *mut nw_path_monitor;
-struct nw_path;
-struct dispatch_queue;
-type dispatch_queue_t = *mut dispatch_queue;
+#[repr(C)]
+struct NwPathMonitor([u8; 0]);
+type NwPathMonitorT = *mut NwPathMonitor;
+#[repr(C)]
+struct NwPath([u8; 0]);
+#[repr(C)]
+struct DispatchQueue([u8; 0]);
+type DispatchQueueT = *mut DispatchQueue;

 const QOS_CLASS_BACKGROUND: usize = 0x09;
 
 const QOS_CLASS_BACKGROUND: usize = 0x09;
 

-unsafe impl objc2::Encode for nw_path {
+unsafe impl objc2::Encode for NwPath {

     const ENCODING: Encoding = usize::ENCODING;
 }
 
     const ENCODING: Encoding = usize::ENCODING;
 }
 

+unsafe impl Send for WatchHandle {}
+

 #[link(name = "Network", kind = "framework")]
 extern "C" {
 #[link(name = "Network", kind = "framework")]
 extern "C" {

-    fn nw_path_monitor_create() -> nw_path_monitor_t;
+    fn nw_path_monitor_create() -> NwPathMonitorT;

     fn nw_path_monitor_set_update_handler(
     fn nw_path_monitor_set_update_handler(

-        monitor: nw_path_monitor_t,
-        update_handler: &Block<dyn Fn(nw_path)>,
+        monitor: NwPathMonitorT,
+        update_handler: &Block<dyn Fn(NwPath)>,

     );
     );

-    fn nw_path_monitor_set_queue(monitor: nw_path_monitor_t, queue: dispatch_queue_t);
-    fn nw_path_monitor_start(monitor: nw_path_monitor_t);
-    fn nw_path_monitor_cancel(monitor: nw_path_monitor_t);
+    fn nw_path_monitor_set_queue(monitor: NwPathMonitorT, queue: DispatchQueueT);
+    fn nw_path_monitor_start(monitor: NwPathMonitorT);
+    fn nw_path_monitor_cancel(monitor: NwPathMonitorT);

 
 

-    fn dispatch_get_global_queue(identifier: usize, flag: usize) -> dispatch_queue_t;
+    fn dispatch_get_global_queue(identifier: usize, flag: usize) -> DispatchQueueT;

 }
 
 pub(crate) struct WatchHandle {
 }
 
 pub(crate) struct WatchHandle {

-    path_monitor: nw_path_monitor_t,
+    path_monitor: NwPathMonitorT,

 }
 
 impl Drop for WatchHandle {
     fn drop(&mut self) {
 }
 
 impl Drop for WatchHandle {
     fn drop(&mut self) {

-        unsafe { nw_path_monitor_cancel(self.path_monitor); }
+        unsafe {
+            nw_path_monitor_cancel(self.path_monitor);
+        }

     }
 }
 
     }
 }
 


@@ -57,7 +64,7 @@ pub(crate) fn watch_interfaces<F: FnMut(Update) + Send + 'static>(
     };
     // Blocks are Fn, not FnMut
     let state = Mutex::new(state);
     };
     // Blocks are Fn, not FnMut
     let state = Mutex::new(state);

-    let block = RcBlock::new(move |_: nw_path| {
+    let block = RcBlock::new(move |_: NwPath| {

         let mut state = state.lock().unwrap();
         let Ok(new_list) = crate::list::list_interfaces() else {
             return;
         let mut state = state.lock().unwrap();
         let Ok(new_list) = crate::list::list_interfaces() else {
             return;


@@ -72,7 +79,7 @@ pub(crate) fn watch_interfaces<F: FnMut(Update) + Send + 'static>(
         (state.callback)(update);
         state.prev_list = new_list;
     });
         (state.callback)(update);
         state.prev_list = new_list;
     });

-    let path_monitor: nw_path_monitor_t;
+    let path_monitor: NwPathMonitorT;

     unsafe {
         let queue = dispatch_get_global_queue(QOS_CLASS_BACKGROUND, 0);
         path_monitor = nw_path_monitor_create();
     unsafe {
         let queue = dispatch_get_global_queue(QOS_CLASS_BACKGROUND, 0);
         path_monitor = nw_path_monitor_create();


@@ -80,7 +87,5 @@ pub(crate) fn watch_interfaces<F: FnMut(Update) + Send + 'static>(
         nw_path_monitor_set_queue(path_monitor, queue);
         nw_path_monitor_start(path_monitor);
     }
         nw_path_monitor_set_queue(path_monitor, queue);
         nw_path_monitor_start(path_monitor);
     }

-    Ok(WatchHandle {
-        path_monitor,
-    })
+    Ok(WatchHandle { path_monitor })

 }
 }