From dbcd6b5b682e6376ff608f8a0f8f8060384fd5e9 Mon Sep 17 00:00:00 2001 From: David Ackroyd Date: Mon, 3 Aug 2020 04:11:29 +0100 Subject: [PATCH] Add WebSocket support; wraps BCL ClientWebSocket (squashed PR #2237) Co-authored-by: David Ackroyd --- .../Api/WebSocketClient.cs | 67 ++++++++++++++ .../lua/CommonLibs/CommLuaLibrary.cs | 43 +++++++++ .../lua/LuaHelperLibs/WebSocketLuaLibrary.cs | 87 +++++++++++++++++++ 3 files changed, 197 insertions(+) create mode 100644 src/BizHawk.Client.Common/Api/WebSocketClient.cs create mode 100644 src/BizHawk.Client.Common/lua/LuaHelperLibs/WebSocketLuaLibrary.cs diff --git a/src/BizHawk.Client.Common/Api/WebSocketClient.cs b/src/BizHawk.Client.Common/Api/WebSocketClient.cs new file mode 100644 index 0000000000..3bdcd2bbd2 --- /dev/null +++ b/src/BizHawk.Client.Common/Api/WebSocketClient.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Net.WebSockets; +using System.Text; +using System.Threading; + +namespace BizHawk.Client.Common +{ + public class WebSocketClient + { + private Dictionary activeSockets; + + public WebSocketClient() + { + activeSockets = new Dictionary(); + } + + public string OpenSocket(string url) + { + var ws = new ClientWebSocket(); + var id = new Guid().ToString(); + + ws.ConnectAsync(new Uri(url), CancellationToken.None).Wait(); + + activeSockets[id] = ws; + + return id; + } + + public void SendToSocket(string id, string content, bool endOfMessage) + { + var ws = activeSockets[id]; + var msg = new ArraySegment(Encoding.UTF8.GetBytes(content)); + + ws.SendAsync(msg, WebSocketMessageType.Text, endOfMessage, CancellationToken.None); + } + + public string ReceiveFromSocket(string id, int maxRead) + { + var ws = activeSockets[id]; + + var rcvBytes = new byte[maxRead]; + var rcvBuffer = new ArraySegment(rcvBytes); + + var result = ws.ReceiveAsync(rcvBuffer, CancellationToken.None).Result; + string rcvMsg = Encoding.UTF8.GetString(rcvBuffer.Take(result.Count).ToArray()); + + return rcvMsg; + } + + public int GetSocketStatus(string id) + { + var ws = activeSockets[id]; + + return (int)ws.State; + } + + public void CloseSocket(string id, int status, string closeMessage) + { + var ws = activeSockets[id]; + + ws.CloseAsync((WebSocketCloseStatus)status, closeMessage, CancellationToken.None); + } + } +} \ No newline at end of file diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs index 8ab2c03073..3561a02301 100644 --- a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs @@ -237,6 +237,41 @@ namespace BizHawk.Client.Common return APIs.Comm.HTTP?.GetUrl; } + //[LuaMethodExample("local ws = bizsocket.open('wss://echo.websocket.org');")] + //[LuaMethod("websocket_open", "Opens a websocket and returns the id so that it can be retrieved later.")] + //public string OpenSocket(string url) + //{ + // return APIs.Comm.WebSocketClient?.OpenSocket(url); + //} + + //[LuaMethodExample("local ws = bizsocket.send(ws_id, 'some message', true);")] + //[LuaMethod("websocket_send", "Send a message to a certain websocket id (boolean flag endOfMessage)")] + //public void SendToSocket(string id, string content, bool endOfMessage) + //{ + // APIs.Comm.WebSocketClient?.SendToSocket(id, content, endOfMessage); + //} + + //[LuaMethodExample("local ws = bizsocket.receive(ws_id, max_read);")] + //[LuaMethod("websocket_receive", "Receive a message from a certain websocket id and a maximum number of bytes to read.")] + //public string ReceiveFromSocket(string id, int maxRead) + //{ + // return APIs.Comm.WebSocketClient?.ReceiveFromSocket(id, maxRead); + //} + + //[LuaMethodExample("local ws_status = bizsocket.getstatus(ws_id);")] + //[LuaMethod("websocket_getStatus", "Get a websocket's status")] + //public int? GetSocketStatus(string id) + //{ + // return APIs.Comm.WebSocketClient?.GetSocketStatus(id); + //} + + //[LuaMethodExample("local ws_status = bizsocket.close(ws_id, close_status);")] + //[LuaMethod("websocket_close", "Close a websocket connection with a close status, defined in section 11.7 of the web sockets protocol spec.")] + //public void CloseSocket(string id, int status, string closeMessage) + //{ + // APIs.Comm.WebSocketClient?.CloseSocket(id, status, closeMessage); + //} + private void CheckHttp() { if (APIs.Comm.HTTP == null) @@ -244,5 +279,13 @@ namespace BizHawk.Client.Common Log("HTTP was not initialized, please initialize it via the command line"); } } + + //private void CheckWebSocket() + //{ + // if (APIs.Comm.WebSocketClient == null) + // { + // Log("WebSocketClient was not initialized"); + // } + //} } } \ No newline at end of file diff --git a/src/BizHawk.Client.Common/lua/LuaHelperLibs/WebSocketLuaLibrary.cs b/src/BizHawk.Client.Common/lua/LuaHelperLibs/WebSocketLuaLibrary.cs new file mode 100644 index 0000000000..a0556e5587 --- /dev/null +++ b/src/BizHawk.Client.Common/lua/LuaHelperLibs/WebSocketLuaLibrary.cs @@ -0,0 +1,87 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Net.WebSockets; +using System.Text; +using System.Threading; +using NLua; + + +namespace BizHawk.Client.Common.lua.LuaHelperLibs +{ + [Description("A library exposing standard .NET string methods")] + public sealed class WebSocketLuaLibrary : LuaLibraryBase + { + private Dictionary activeSockets; + + public WebSocketLuaLibrary(Lua lua) : base(lua) + { + activeSockets = new Dictionary(); + } + + public WebSocketLuaLibrary(Lua lua, Action logOutputCallback) : base(lua, logOutputCallback) + { + activeSockets = new Dictionary(); + } + + public override string Name => "bizsocket"; + + [LuaMethodExample("local ws = bizsocket.open('wss://echo.websocket.org');")] + [LuaMethod("open", "Opens a websocket and returns the id so that it can be retrieved later.")] + public string OpenSocket(string url) + { + var ws = new ClientWebSocket(); + var id = new Guid().ToString(); + + ws.ConnectAsync(new Uri(url), CancellationToken.None).Wait(); + + activeSockets[id] = ws; + + return id; + } + + [LuaMethodExample("local ws = bizsocket.send(ws_id, 'some message', true);")] + [LuaMethod("send", "Send a message to a certain websocket id (boolean flag endOfMessage)")] + public void SendToSocket(string id, string content, bool endOfMessage) + { + var ws = activeSockets[id]; + var msg = new ArraySegment(Encoding.UTF8.GetBytes(content)); + + ws.SendAsync(msg, WebSocketMessageType.Text, endOfMessage, CancellationToken.None); + } + + [LuaMethodExample("local ws = bizsocket.receive(ws_id, max_read);")] + [LuaMethod("receive", "Receive a message from a certain websocket id and a maximum number of bytes to read.")] + public string ReceiveFromSocket(string id, int maxRead) + { + var ws = activeSockets[id]; + + var rcvBytes = new byte[maxRead]; + var rcvBuffer = new ArraySegment(rcvBytes); + + var result = ws.ReceiveAsync(rcvBuffer, CancellationToken.None).Result; + string rcvMsg = Encoding.UTF8.GetString(rcvBuffer.Take(result.Count).ToArray()); + + return rcvMsg; + } + + [LuaMethodExample("local ws_status = bizsocket.getstatus(ws_id);")] + [LuaMethod("getStatus", "Get a websocket's status")] + public int GetSocketStatus(string id) + { + var ws = activeSockets[id]; + + return (int)ws.State; + } + + [LuaMethodExample("local ws_status = bizsocket.close(ws_id, close_status);")] + [LuaMethod("close", "Close a websocket connection with a close status, defined in section 11.7 of the web sockets protocol spec.")] + public void CloseSocket(string id, int status, string closeMessage) + { + var ws = activeSockets[id]; + + ws.CloseAsync((WebSocketCloseStatus) status, closeMessage, CancellationToken.None); + } + } +}