ButtplugWSClient::SendMessage() always increments the msgID

This means consumers of the library do not need to manually set the message IDs at all now.

Fixes #318

Author: blackspherefollower

Buttplug.Client.Test/ButtPlugClientTests.cs

@@ -42,7 +42,7 @@ public async void TestConnection()
             Assert.True(res != null);
             Assert.True(res is Core.Messages.Test);
             Assert.True(((Core.Messages.Test)res).TestString == "Test string");
-            Assert.True(((Core.Messages.Test)res).Id == msgId);
+            Assert.True(((Core.Messages.Test)res).Id > msgId);
 
             // Check ping is working
             Thread.Sleep(400);
@@ -52,9 +52,15 @@ public async void TestConnection()
             Assert.True(res != null);
             Assert.True(res is Core.Messages.Test);
             Assert.True(((Core.Messages.Test)res).TestString == "Test string");
-            Assert.True(((Core.Messages.Test)res).Id == msgId);
+            Assert.True(((Core.Messages.Test)res).Id > msgId);
 
-            Assert.True(client.nextMsgId > 4);
+            res = await client.SendMsg(new Core.Messages.Test("Test string"));
+            Assert.True(res != null);
+            Assert.True(res is Core.Messages.Test);
+            Assert.True(((Core.Messages.Test)res).TestString == "Test string");
+            Assert.True(((Core.Messages.Test)res).Id > msgId);
+
+            Assert.True(client.nextMsgId > 5);
 
             await client.RequestDeviceList();
 
@@ -77,7 +83,7 @@ public async void TestSSLConnection()
             Assert.True(res != null);
             Assert.True(res is Core.Messages.Test);
             Assert.True(((Core.Messages.Test)res).TestString == "Test string");
-            Assert.True(((Core.Messages.Test)res).Id == msgId);
+            Assert.True(((Core.Messages.Test)res).Id > msgId);
 
             // Check ping is working
             Thread.Sleep(400);
@@ -87,7 +93,7 @@ public async void TestSSLConnection()
             Assert.True(res != null);
             Assert.True(res is Core.Messages.Test);
             Assert.True(((Core.Messages.Test)res).TestString == "Test string");
-            Assert.True(((Core.Messages.Test)res).Id == msgId);
+            Assert.True(((Core.Messages.Test)res).Id > msgId);
 
             Assert.True(client.nextMsgId > 4);
 

Buttplug.Client/ButtplugWSClient.cs

@@ -7,9 +7,9 @@
 using Buttplug.Core;
 using Buttplug.Core.Messages;
 using JetBrains.Annotations;
-using static Buttplug.Client.DeviceEventArgs;
-using WebSocket4Net;
 using SuperSocket.ClientEngine;
+using WebSocket4Net;
+using static Buttplug.Client.DeviceEventArgs;
 
 namespace Buttplug.Client
 {
@@ -305,7 +305,7 @@ private async void onPingTimer(object state)
         {
             try
             {
-                var msg = await SendMessage(new Ping(nextMsgId));
+                var msg = await SendMessage(new Ping());
                 if (msg is Error)
                 {
                     _owningDispatcher.Send(_ =>
@@ -326,7 +326,7 @@ private async void onPingTimer(object state)
 
         public async Task RequestDeviceList()
         {
-            var resp = await SendMessage(new RequestDeviceList(nextMsgId));
+            var resp = await SendMessage(new RequestDeviceList());
             if (!(resp is DeviceList) || (resp as DeviceList).Devices == null)
             {
                 if (resp is Error)
@@ -365,17 +365,17 @@ public ButtplugClientDevice[] getDevices()
 
         public async Task<bool> StartScanning()
         {
-            return await SendMessageExpectOk(new StartScanning(nextMsgId));
+            return await SendMessageExpectOk(new StartScanning());
         }
 
         public async Task<bool> StopScanning()
         {
-            return await SendMessageExpectOk(new StopScanning(nextMsgId));
+            return await SendMessageExpectOk(new StopScanning());
         }
 
         public async Task<bool> RequestLog(string aLogLevel)
         {
-            return await this.SendMessageExpectOk(new RequestLog(aLogLevel, nextMsgId));
+            return await this.SendMessageExpectOk(new RequestLog(aLogLevel));
         }
 
         public async Task<ButtplugMessage> SendDeviceMessage(ButtplugClientDevice aDevice, ButtplugDeviceMessage aDeviceMsg)
@@ -403,6 +403,9 @@ protected async Task<bool> SendMessageExpectOk(ButtplugMessage aMsg)
 
         protected async Task<ButtplugMessage> SendMessage(ButtplugMessage aMsg)
         {
+            // The client always increments the IDs on outgoing messages
+            aMsg.Id = nextMsgId;
+
             var promise = new TaskCompletionSource<ButtplugMessage>();
             _waitingMsgs.TryAdd(aMsg.Id, promise);