Gracefully disconnect socket when acquisition stops

.github/workflows/linux.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  artifactoryApiKey: ${{ secrets.artifactoryApiKey }}
+  ARTIFACTORY_ACCESS_TOKEN: ${{ secrets.ARTIFACTORY_ACCESS_TOKEN }}
   build_dir: "Build"
   package: EphysSocket-linux
 
@@ -43,4 +43,4 @@ jobs:
         cp -r $build_dir/*.so plugins
         zipfile=${package}_${new_plugin_ver}.zip
         zip -r -X $zipfile plugins
-        curl -H "X-JFrog-Art-Api:$artifactoryApiKey" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/linux/$zipfile"
+        curl -H "X-JFrog-Art-Api:$ARTIFACTORY_ACCESS_TOKEN" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/linux/$zipfile"

.github/workflows/mac.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  artifactoryApiKey: ${{ secrets.artifactoryApiKey }}
+  ARTIFACTORY_ACCESS_TOKEN: ${{ secrets.ARTIFACTORY_ACCESS_TOKEN }}
   build_dir: "Build/Release"
   package: EphysSocket-mac
 
@@ -41,4 +41,4 @@ jobs:
         cp -r $build_dir/*.bundle plugins
         zipfile=${package}_${new_plugin_ver}.zip
         zip -r -X $zipfile plugins
-        curl -H "X-JFrog-Art-Api:$artifactoryApiKey" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/mac/$zipfile"
+        curl -H "X-JFrog-Art-Api:$ARTIFACTORY_ACCESS_TOKEN" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/mac/$zipfile"

.github/workflows/windows.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  artifactoryApiKey: ${{ secrets.artifactoryApiKey }}
+  ARTIFACTORY_ACCESS_TOKEN: ${{ secrets.ARTIFACTORY_ACCESS_TOKEN }}
   build_dir: "Build/Release"
   package: EphysSocket-windows
 
@@ -28,7 +28,7 @@ jobs:
         cd plugin-GUI/Build
         cmake -G "Visual Studio 16 2019" -A x64 .. 
         mkdir Release && cd Release
-        curl -L https://openephysgui.jfrog.io/artifactory/Libraries/open-ephys-lib-v0.6.0.zip --output open-ephys-lib.zip 
+        curl -L https://openephys.jfrog.io/artifactory/GUI-binaries/Libraries/open-ephys-lib-v0.6.0.zip --output open-ephys-lib.zip 
         unzip open-ephys-lib.zip
       shell: bash
 
@@ -58,5 +58,5 @@ jobs:
         cp $build_dir/*.dll plugins
         zipfile=${package}_${new_plugin_ver}.zip
         powershell Compress-Archive -Path "plugins" -DestinationPath ${zipfile}
-        curl -H "X-JFrog-Art-Api:$artifactoryApiKey" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/windows/$zipfile"
+        curl -H "X-JFrog-Art-Api:$ARTIFACTORY_ACCESS_TOKEN" -T $zipfile "https://openephys.jfrog.io/artifactory/EphysSocket-plugin/windows/$zipfile"
       shell: bash

CMakeLists.txt

@@ -65,6 +65,7 @@ if(MSVC)
 	target_compile_options(${PLUGIN_NAME} PRIVATE /sdl- /W0)
 
 	install(TARGETS ${PLUGIN_NAME} RUNTIME DESTINATION ${GUI_BIN_DIR}/plugins  CONFIGURATIONS ${CMAKE_CONFIGURATION_TYPES})
+  install(FILES $<TARGET_PDB_FILE:${PLUGIN_NAME}> DESTINATION  ${GUI_BIN_DIR}/plugins OPTIONAL)
 
 	set(CMAKE_PREFIX_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../libs)
 elseif(LINUX)

Resources/python-example-tcp.py

@@ -38,14 +38,14 @@
 oneCycle = np.concatenate((intList_1, intList_2))
 allData = np.tile(oneCycle, (numChannels, totalDuration)).T
 
+# ---- WAIT FOR USER INPUT ---- #
+value = input("Press enter key to start...")
+
 # ---- CREATE THE SOCKET SERVER ---- #
 tcpServer = socket.socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
 tcpServer.bind(('localhost', 9001))
 tcpServer.listen(1)
 
-# ---- WAIT FOR USER INPUT ---- #
-value = input("Press enter key to start...")
-
 print("Waiting for external connection to start...")
 (tcpClient, address) = tcpServer.accept()
 print("Connected.")
@@ -61,14 +61,23 @@ def currentTime():
     return time.time_ns() / (10 ** 9)
 
 # ---- STREAM DATA ---- #
-while (bufferIndex < totalBytes):
-    t1 = currentTime()
-    rc = tcpClient.sendto(header + bytesToSend[bufferIndex:bufferIndex+bytesPerBuffer], address)
-    t2 = currentTime()
-
-    while ((t2 - t1) < bufferInterval):
+try:
+    while (bufferIndex < totalBytes):
+        t1 = currentTime()
+        rc = tcpClient.sendto(header + bytesToSend[bufferIndex:bufferIndex+bytesPerBuffer], address)
         t2 = currentTime()
-
-    bufferIndex += bytesPerBuffer
+
+        while ((t2 - t1) < bufferInterval):
+            t2 = currentTime()
+
+        bufferIndex += bytesPerBuffer
+
+    print("Done")
+except BrokenPipeError:
+    print("Connection closed by the server. Unable to send data. Exiting...")
+
+except ConnectionAbortedError:
+    print("Connection was aborted, unable to send data. Try disconnecting and reconnecting the remote client. Exiting...")
 
-print("Done")
+except ConnectionResetError:
+    print("Connection was aborted, unable to send data. Try disconnecting and reconnecting the remote client. Exiting...")

Source/EphysSocket.cpp

@@ -12,7 +12,7 @@ DataThread* EphysSocket::createDataThread(SourceNode* sn)
 	return new EphysSocket(sn);
 }
 
-EphysSocket::EphysSocket(SourceNode* sn) : DataThread(sn), socket("socket_thread")
+EphysSocket::EphysSocket(SourceNode* sn) : DataThread(sn), socket("socket_thread", this)
 {
 	port = DEFAULT_PORT;
 	sample_rate = DEFAULT_SAMPLE_RATE;
@@ -39,7 +39,9 @@ EphysSocket::~EphysSocket()
 }
 
 void EphysSocket::disconnectSocket()
-{
+{    
+	socket.signalThreadShouldExit();
+	socket.waitForThreadToExit(1000);
 	socket.disconnectSocket();
 }
 

Source/OpenEphysLib.cpp

@@ -38,7 +38,7 @@ extern "C" EXPORT void getLibInfo(Plugin::LibraryInfo* info)
 {
 	info->apiVersion = PLUGIN_API_VER;
 	info->name = "Ephys Socket";
-	info->libVersion = "0.4.0";
+	info->libVersion = "0.4.1";
 	info->numPlugins = NUM_PLUGINS;
 }
 

Source/SocketThread.cpp

@@ -3,11 +3,12 @@
 #endif
 
 #include "SocketThread.h"
+#include "EphysSocket.h"
 
 using namespace EphysSocketNode;
 
-SocketThread::SocketThread(String name)
-	: Thread(name), editor(NULL)
+SocketThread::SocketThread(String name, EphysSocket* processor_)
+	: Thread(name), editor(NULL), processor(processor_)
 {
 	lastPacketReceived = time(nullptr);
 
@@ -51,6 +52,12 @@ void SocketThread::startAcquisition()
 void SocketThread::stopAcquisition()
 {
 	acquiring = false;
+
+	if (shouldReconnect)
+	{
+		processor->disconnectSocket();
+		editor->enableInputs();
+	}
 }
 
 bool SocketThread::connectSocket(int port, bool printOutput)

Source/SocketThread.h

@@ -32,11 +32,13 @@
 
 namespace EphysSocketNode
 {
+	class EphysSocket;
+
 	class SocketThread : public Thread
 	{
 	public:
 
-		SocketThread(String name);
+		SocketThread(String name, EphysSocket*);
 
 		~SocketThread();
 
@@ -87,6 +89,9 @@ namespace EphysSocketNode
 		/** Pointer to the editor */
 		EphysSocketEditor* editor;
 
+		/** Pointer to the plugin processor */
+		EphysSocket* processor;
+
 		/** TCP Socket object */
 		std::unique_ptr<StreamingSocket> socket;