CInterface: add Close function

BloomyControls · Nov 14, 2024 · 984be6f · 984be6f
1 parent e3a2b35
commit 984be6f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/include/bci/abs/CInterface.h b/include/bci/abs/CInterface.h
@@ -265,6 +265,15 @@ int AbsScpiClient_OpenSerial(AbsScpiClientHandle handle, const char* com_port,
 int AbsScpiClient_OpenUdpMulticast(AbsScpiClientHandle handle,
                                    const char* interface_ip);
 
+/**
+ * @brief Close the client connection.
+ *
+ * @param[in] handle SCPI client
+ *
+ * @return 0 on success or a negative error code.
+ */
+int AbsScpiClient_Close(AbsScpiClientHandle handle);
+
 /**
  * @brief Set the target device ID for communication. Only applies to RS-485
  * connections.

diff --git a/src/CInterface.cpp b/src/CInterface.cpp
@@ -204,6 +204,20 @@ int AbsScpiClient_OpenUdpMulticast(AbsScpiClientHandle handle,
   return static_cast<int>(ec::kUnexpectedException);
 }
 
+int AbsScpiClient_Close(AbsScpiClientHandle handle) try {
+  if (!handle) {
+    return static_cast<int>(ec::kInvalidArgument);
+  }
+
+  GetClient(handle).SetDriver(nullptr);
+
+  return static_cast<int>(ec::kSuccess);
+} catch (const std::bad_alloc&) {
+  return static_cast<int>(ec::kAllocationFailed);
+} catch (...) {
+  return static_cast<int>(ec::kUnexpectedException);
+}
+
 int AbsScpiClient_SetTargetDeviceId(AbsScpiClientHandle handle,
                                     unsigned int device_id) try {
   if (!handle) {