Merge pull request #101 from elmarco/interrupt-event

Add Context::interrupt_handle_events()

libusb1-sys/src/lib.rs

@@ -426,6 +426,7 @@ extern "system" {
         completed: *mut c_int,
     ) -> c_int;
     pub fn libusb_handle_events_locked(context: *mut libusb_context, tv: *const timeval) -> c_int;
+    pub fn libusb_interrupt_event_handler(context: *mut libusb_context);
 
     pub fn libusb_try_lock_events(context: *mut libusb_context) -> c_int;
     pub fn libusb_lock_events(context: *mut libusb_context);

src/context.rs

@@ -109,13 +109,13 @@ pub trait UsbContext: Clone + Sized + Send + Sync {
     /// [Hotplug::device_arrived] method is called when a new device is added to
     /// the bus, and [Hotplug::device_left] is called when it is removed.
     ///
-    /// Devices can optionally be filtered by vendor ([vendor_id]) and device id
-    /// ([device_id]). If [enumerate] is `true`, then devices that are already
-    /// connected will cause your callback's `device_arrived()` method to be
-    /// called for them.
+    /// Devices can optionally be filtered by `vendor_id` and `device_id`. If
+    /// `enumerate` is `true`, then devices that are already connected will
+    /// cause your callback's `device_arrived()` method to be called for them.
     ///
     /// The callback will remain registered until the returned [Registration] is
-    /// dropped, which can be done explicitly with [hotplug_unregister_callback].
+    /// dropped, which can be done explicitly with
+    /// [hotplug_unregister_callback][Self::hotplug_unregister_callback()].
     #[must_use = "USB hotplug callbacks will be deregistered if the registration is dropped"]
     fn hotplug_register_callback(
         &self,
@@ -190,6 +190,15 @@ pub trait UsbContext: Clone + Sized + Send + Sync {
         }
     }
 
+    /// Interrupt any active thread that is handling events (for example with
+    /// [handle_events][`Self::handle_events()`]).
+    #[doc(alias = "libusb_interrupt_event_handler")]
+    fn interrupt_handle_events(&self) {
+        unsafe {
+            libusb_interrupt_event_handler(self.as_raw())
+        }
+    }
+
     fn next_timeout(&self) -> crate::Result<Option<Duration>> {
         let mut tv = timeval { tv_sec: 0, tv_usec: 0 };
         let n = unsafe {