WebSocketTransport.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. #if !BESTHTTP_DISABLE_SOCKETIO
  2. #if !BESTHTTP_DISABLE_WEBSOCKET
  3. using System;
  4. using System.Collections.Generic;
  5. namespace BestHTTP.SocketIO3.Transports
  6. {
  7. using BestHTTP.Connections;
  8. using BestHTTP.PlatformSupport.Memory;
  9. using BestHTTP.WebSocket;
  10. using Extensions;
  11. /// <summary>
  12. /// A transport implementation that can communicate with a SocketIO server.
  13. /// </summary>
  14. public sealed class WebSocketTransport : ITransport
  15. {
  16. public TransportTypes Type { get { return TransportTypes.WebSocket; } }
  17. public TransportStates State { get; private set; }
  18. public SocketManager Manager { get; private set; }
  19. public bool IsRequestInProgress { get { return false; } }
  20. public bool IsPollingInProgress { get { return false; } }
  21. public WebSocket Implementation { get; private set; }
  22. public WebSocketTransport(SocketManager manager)
  23. {
  24. State = TransportStates.Closed;
  25. Manager = manager;
  26. }
  27. #region Some ITransport Implementation
  28. public void Open()
  29. {
  30. if (State != TransportStates.Closed)
  31. return;
  32. Uri uri = null;
  33. string baseUrl = new UriBuilder(HTTPProtocolFactory.IsSecureProtocol(Manager.Uri) ? "wss" : "ws",
  34. Manager.Uri.Host,
  35. Manager.Uri.Port,
  36. Manager.Uri.GetRequestPathAndQueryURL()).Uri.ToString();
  37. string format = "{0}?EIO={1}&transport=websocket{3}";
  38. if (Manager.Handshake != null)
  39. format += "&sid={2}";
  40. bool sendAdditionalQueryParams = !Manager.Options.QueryParamsOnlyForHandshake || (Manager.Options.QueryParamsOnlyForHandshake && Manager.Handshake == null);
  41. uri = new Uri(string.Format(format,
  42. baseUrl,
  43. Manager.ProtocolVersion,
  44. Manager.Handshake != null ? Manager.Handshake.Sid : string.Empty,
  45. sendAdditionalQueryParams ? Manager.Options.BuildQueryParams() : string.Empty));
  46. Implementation = new WebSocket(uri, string.Empty, string.Empty
  47. #if !UNITY_WEBGL || UNITY_EDITOR
  48. , (Manager.Options.WebsocketOptions?.ExtensionsFactory ?? WebSocket.GetDefaultExtensions)?.Invoke()
  49. #endif
  50. );
  51. #if !UNITY_WEBGL || UNITY_EDITOR
  52. if (this.Manager.Options.WebsocketOptions?.PingIntervalOverride is TimeSpan ping)
  53. {
  54. if (ping > TimeSpan.Zero)
  55. {
  56. Implementation.StartPingThread = true;
  57. Implementation.PingFrequency = (int)ping.TotalMilliseconds;
  58. }
  59. else
  60. Implementation.StartPingThread = false;
  61. }
  62. else
  63. Implementation.StartPingThread = true;
  64. if (this.Manager.Options.HTTPRequestCustomizationCallback != null)
  65. Implementation.OnInternalRequestCreated = (ws, internalRequest) => this.Manager.Options.HTTPRequestCustomizationCallback(this.Manager, internalRequest);
  66. #endif
  67. Implementation.OnOpen = OnOpen;
  68. Implementation.OnMessage = OnMessage;
  69. Implementation.OnBinaryNoAlloc = OnBinaryNoAlloc;
  70. Implementation.OnError = OnError;
  71. Implementation.OnClosed = OnClosed;
  72. Implementation.Open();
  73. State = TransportStates.Connecting;
  74. }
  75. /// <summary>
  76. /// Closes the transport and cleans up resources.
  77. /// </summary>
  78. public void Close()
  79. {
  80. if (State == TransportStates.Closed)
  81. return;
  82. State = TransportStates.Closed;
  83. if (Implementation != null)
  84. Implementation.Close();
  85. else
  86. HTTPManager.Logger.Warning("WebSocketTransport", "Close - WebSocket Implementation already null!", this.Manager.Context);
  87. Implementation = null;
  88. }
  89. /// <summary>
  90. /// Polling implementation. With WebSocket it's just a skeleton.
  91. /// </summary>
  92. public void Poll()
  93. {
  94. }
  95. #endregion
  96. #region WebSocket Events
  97. /// <summary>
  98. /// WebSocket implementation OnOpen event handler.
  99. /// </summary>
  100. private void OnOpen(WebSocket ws)
  101. {
  102. if (ws != Implementation)
  103. return;
  104. HTTPManager.Logger.Information("WebSocketTransport", "OnOpen", this.Manager.Context);
  105. State = TransportStates.Opening;
  106. // Send a Probe packet to test the transport. If we receive back a pong with the same payload we can upgrade
  107. if (Manager.UpgradingTransport == this)
  108. Send(this.Manager.Parser.CreateOutgoing(TransportEventTypes.Ping, "probe"));
  109. }
  110. /// <summary>
  111. /// WebSocket implementation OnMessage event handler.
  112. /// </summary>
  113. private void OnMessage(WebSocket ws, string message)
  114. {
  115. if (ws != Implementation)
  116. return;
  117. if (HTTPManager.Logger.Level <= BestHTTP.Logger.Loglevels.All)
  118. HTTPManager.Logger.Verbose("WebSocketTransport", "OnMessage: " + message, this.Manager.Context);
  119. IncomingPacket packet = IncomingPacket.Empty;
  120. try
  121. {
  122. packet = this.Manager.Parser.Parse(this.Manager, message);
  123. if (packet.TransportEvent == TransportEventTypes.Open)
  124. {
  125. packet.DecodedArg = BestHTTP.JSON.LitJson.JsonMapper.ToObject<HandshakeData>(packet.DecodedArg as string);
  126. }
  127. }
  128. catch (Exception ex)
  129. {
  130. HTTPManager.Logger.Exception("WebSocketTransport", "OnMessage Packet parsing", ex, this.Manager.Context);
  131. }
  132. if (!packet.Equals(IncomingPacket.Empty))
  133. {
  134. try
  135. {
  136. OnPacket(packet);
  137. }
  138. catch (Exception ex)
  139. {
  140. HTTPManager.Logger.Exception("WebSocketTransport", "OnMessage OnPacket", ex, this.Manager.Context);
  141. }
  142. }
  143. else if (HTTPManager.Logger.Level == Logger.Loglevels.All)
  144. HTTPManager.Logger.Verbose("WebSocketTransport", "OnMessage: skipping message " + message, this.Manager.Context);
  145. }
  146. /// <summary>
  147. /// WebSocket implementation OnBinary event handler.
  148. /// </summary>
  149. private void OnBinaryNoAlloc(WebSocket ws, BufferSegment data)
  150. {
  151. if (ws != Implementation)
  152. return;
  153. if (HTTPManager.Logger.Level <= BestHTTP.Logger.Loglevels.All)
  154. HTTPManager.Logger.Verbose("WebSocketTransport", $"OnBinaryNoAlloc({data})", this.Manager.Context);
  155. IncomingPacket packet = IncomingPacket.Empty;
  156. try
  157. {
  158. packet = this.Manager.Parser.Parse(this.Manager, data);
  159. }
  160. catch (Exception ex)
  161. {
  162. HTTPManager.Logger.Exception("WebSocketTransport", $"OnBinaryNoAlloc({data}) Packet parsing", ex, this.Manager.Context);
  163. }
  164. if (!packet.Equals(IncomingPacket.Empty))
  165. {
  166. try
  167. {
  168. OnPacket(packet);
  169. }
  170. catch (Exception ex)
  171. {
  172. HTTPManager.Logger.Exception("WebSocketTransport", $"OnBinaryNoAlloc({data}) OnPacket", ex, this.Manager.Context);
  173. }
  174. }
  175. else if (HTTPManager.Logger.Level == Logger.Loglevels.All)
  176. HTTPManager.Logger.Verbose("WebSocketTransport", "OnBinaryNoAlloc skipping message", this.Manager.Context);
  177. }
  178. /// <summary>
  179. /// WebSocket implementation OnError event handler.
  180. /// </summary>
  181. private void OnError(WebSocket ws, string error)
  182. {
  183. if (ws != Implementation)
  184. return;
  185. #if !UNITY_WEBGL || UNITY_EDITOR
  186. if (string.IsNullOrEmpty(error))
  187. {
  188. switch (ws.InternalRequest.State)
  189. {
  190. // The request finished without any problem.
  191. case HTTPRequestStates.Finished:
  192. if (ws.InternalRequest.Response.IsSuccess || ws.InternalRequest.Response.StatusCode == 101)
  193. error = string.Format("Request finished. Status Code: {0} Message: {1}", ws.InternalRequest.Response.StatusCode.ToString(), ws.InternalRequest.Response.Message);
  194. else
  195. error = string.Format("Request Finished Successfully, but the server sent an error. Status Code: {0}-{1} Message: {2}",
  196. ws.InternalRequest.Response.StatusCode,
  197. ws.InternalRequest.Response.Message,
  198. ws.InternalRequest.Response.DataAsText);
  199. break;
  200. // The request finished with an unexpected error. The request's Exception property may contain more info about the error.
  201. case HTTPRequestStates.Error:
  202. error = "Request Finished with Error! : " + ws.InternalRequest.Exception != null ? (ws.InternalRequest.Exception.Message + " " + ws.InternalRequest.Exception.StackTrace) : string.Empty;
  203. break;
  204. // The request aborted, initiated by the user.
  205. case HTTPRequestStates.Aborted:
  206. error = "Request Aborted!";
  207. break;
  208. // Connecting to the server is timed out.
  209. case HTTPRequestStates.ConnectionTimedOut:
  210. error = "Connection Timed Out!";
  211. break;
  212. // The request didn't finished in the given time.
  213. case HTTPRequestStates.TimedOut:
  214. error = "Processing the request Timed Out!";
  215. break;
  216. }
  217. }
  218. #endif
  219. if (Manager.UpgradingTransport != this)
  220. (Manager as IManager).OnTransportError(this, error);
  221. else
  222. Manager.UpgradingTransport = null;
  223. }
  224. /// <summary>
  225. /// WebSocket implementation OnClosed event handler.
  226. /// </summary>
  227. private void OnClosed(WebSocket ws, ushort code, string message)
  228. {
  229. if (ws != Implementation)
  230. return;
  231. HTTPManager.Logger.Information("WebSocketTransport", "OnClosed", this.Manager.Context);
  232. Close();
  233. if (Manager.UpgradingTransport != this)
  234. (Manager as IManager).TryToReconnect();
  235. else
  236. Manager.UpgradingTransport = null;
  237. }
  238. #endregion
  239. #region Packet Sending Implementation
  240. /// <summary>
  241. /// A WebSocket implementation of the packet sending.
  242. /// </summary>
  243. public void Send(OutgoingPacket packet)
  244. {
  245. if (State == TransportStates.Closed ||
  246. State == TransportStates.Paused)
  247. {
  248. HTTPManager.Logger.Information("WebSocketTransport", string.Format("Send - State == {0}, skipping packet sending!", State), this.Manager.Context);
  249. return;
  250. }
  251. if (packet.IsBinary)
  252. Implementation.SendAsBinary(packet.PayloadData);
  253. else
  254. {
  255. Implementation.Send(packet.Payload);
  256. }
  257. if (packet.Attachements != null)
  258. for (int i = 0; i < packet.Attachements.Count; ++i)
  259. Implementation.Send(packet.Attachements[i]);
  260. }
  261. /// <summary>
  262. /// A WebSocket implementation of the packet sending.
  263. /// </summary>
  264. public void Send(List<OutgoingPacket> packets)
  265. {
  266. for (int i = 0; i < packets.Count; ++i)
  267. Send(packets[i]);
  268. packets.Clear();
  269. }
  270. #endregion
  271. #region Packet Handling
  272. /// <summary>
  273. /// Will only process packets that need to upgrade. All other packets are passed to the Manager.
  274. /// </summary>
  275. private void OnPacket(IncomingPacket packet)
  276. {
  277. switch (packet.TransportEvent)
  278. {
  279. case TransportEventTypes.Open:
  280. if (this.State != TransportStates.Opening)
  281. HTTPManager.Logger.Warning("WebSocketTransport", "Received 'Open' packet while state is '" + State.ToString() + "'", this.Manager.Context);
  282. else
  283. State = TransportStates.Open;
  284. goto default;
  285. case TransportEventTypes.Pong:
  286. // Answer for a Ping Probe.
  287. if ("probe".Equals(packet.DecodedArg))
  288. {
  289. State = TransportStates.Open;
  290. (Manager as IManager).OnTransportProbed(this);
  291. }
  292. goto default;
  293. default:
  294. if (Manager.UpgradingTransport != this)
  295. (Manager as IManager).OnPacket(packet);
  296. break;
  297. }
  298. }
  299. #endregion
  300. }
  301. }
  302. #endif
  303. #endif