Create PortUnregistrationError for port registration failures

Author: wmedrano

src/client/client_impl.rs

@@ -564,11 +564,15 @@ impl Client {
         }
     }
 
+    /// Remove the port from the client, disconnecting any existing connections.
+    ///
+    /// `Err(Error::PortUnregistrationError)` is returned on failure, for example if the port does
+    /// not belong to this client.
     pub fn unregister_port<PS>(&self, port: Port<PS>) -> Result<(), Error> {
         let res = unsafe { j::jack_port_unregister(self.raw(), port.raw()) };
         match res {
             0 => Ok(()),
-            _ => Err(Error::PortDisconnectionError),
+            _ => Err(Error::PortUnregistrationError),
         }
     }
 

src/jack_enums.rs

@@ -23,6 +23,7 @@ pub enum Error {
     PortMonitorError,
     PortNamingError,
     PortRegistrationError(String),
+    PortUnregistrationError,
     SetBufferSizeError,
     TimeError,
     WeakFunctionNotFound(&'static str),
@@ -68,6 +69,7 @@ impl std::fmt::Display for Error {
             Error::PortMonitorError => write!(f, "port monitoring error"),
             Error::PortNamingError => write!(f, "port naming error"),
             Error::PortRegistrationError(p) => write!(f, "failed to register port {p}"),
+            Error::PortUnregistrationError => write!(f, "failed to unregister port"),
             Error::SetBufferSizeError => write!(
                 f,
                 "set buffer size error, setting buffer size is likely not supported"

src/tests/client.rs

@@ -86,3 +86,18 @@ fn nonexistant_uuid_to_client_name_returns_none() {
     assert_eq!(DEFAULT_TEST_CLIENT.name_by_uuid_str(&uuid_string), None);
     assert_eq!(DEFAULT_TEST_CLIENT.name_by_uuid(uuid), None);
 }
+
+#[test]
+fn unregistering_another_clients_port_is_an_unregistration_error() {
+    let (owner, _) = crate::Client::new("", crate::ClientOptions::default()).unwrap();
+    let (other, _) = crate::Client::new("", crate::ClientOptions::default()).unwrap();
+    let port = owner.register_port("p", crate::AudioIn::default()).unwrap();
+    // Some servers only publish ports of active clients.
+    let _owner = owner.activate_async((), ()).unwrap();
+    std::thread::sleep(std::time::Duration::from_millis(100));
+    let foreign = other.port_by_name(&port.name().unwrap()).unwrap();
+    assert_eq!(
+        other.unregister_port(foreign),
+        Err(crate::Error::PortUnregistrationError)
+    );
+}