WebSocketTransport.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  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. internal 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);
  47. #if !UNITY_WEBGL || UNITY_EDITOR
  48. if (this.Manager.Options.HTTPRequestCustomizationCallback != null)
  49. Implementation.OnInternalRequestCreated = (ws, internalRequest) => this.Manager.Options.HTTPRequestCustomizationCallback(this.Manager, internalRequest);
  50. #endif
  51. Implementation.OnOpen = OnOpen;
  52. Implementation.OnMessage = OnMessage;
  53. Implementation.OnBinary = OnBinary;
  54. Implementation.OnError = OnError;
  55. Implementation.OnClosed = OnClosed;
  56. Implementation.Open();
  57. State = TransportStates.Connecting;
  58. }
  59. /// <summary>
  60. /// Closes the transport and cleans up resources.
  61. /// </summary>
  62. public void Close()
  63. {
  64. if (State == TransportStates.Closed)
  65. return;
  66. State = TransportStates.Closed;
  67. if (Implementation != null)
  68. Implementation.Close();
  69. else
  70. HTTPManager.Logger.Warning("WebSocketTransport", "Close - WebSocket Implementation already null!", this.Manager.Context);
  71. Implementation = null;
  72. }
  73. /// <summary>
  74. /// Polling implementation. With WebSocket it's just a skeleton.
  75. /// </summary>
  76. public void Poll()
  77. {
  78. }
  79. #endregion
  80. #region WebSocket Events
  81. /// <summary>
  82. /// WebSocket implementation OnOpen event handler.
  83. /// </summary>
  84. private void OnOpen(WebSocket ws)
  85. {
  86. if (ws != Implementation)
  87. return;
  88. HTTPManager.Logger.Information("WebSocketTransport", "OnOpen", this.Manager.Context);
  89. State = TransportStates.Opening;
  90. // Send a Probe packet to test the transport. If we receive back a pong with the same payload we can upgrade
  91. if (Manager.UpgradingTransport == this)
  92. Send(this.Manager.Parser.CreateOutgoing(TransportEventTypes.Ping, "probe"));
  93. }
  94. /// <summary>
  95. /// WebSocket implementation OnMessage event handler.
  96. /// </summary>
  97. private void OnMessage(WebSocket ws, string message)
  98. {
  99. if (ws != Implementation)
  100. return;
  101. if (HTTPManager.Logger.Level <= BestHTTP.Logger.Loglevels.All)
  102. HTTPManager.Logger.Verbose("WebSocketTransport", "OnMessage: " + message, this.Manager.Context);
  103. IncomingPacket packet = IncomingPacket.Empty;
  104. try
  105. {
  106. packet = this.Manager.Parser.Parse(this.Manager, message);
  107. if (packet.TransportEvent == TransportEventTypes.Open)
  108. {
  109. packet.DecodedArg = BestHTTP.JSON.LitJson.JsonMapper.ToObject<HandshakeData>(packet.DecodedArg as string);
  110. }
  111. }
  112. catch (Exception ex)
  113. {
  114. HTTPManager.Logger.Exception("WebSocketTransport", "OnMessage Packet parsing", ex, this.Manager.Context);
  115. }
  116. if (!packet.Equals(IncomingPacket.Empty))
  117. {
  118. try
  119. {
  120. OnPacket(packet);
  121. }
  122. catch (Exception ex)
  123. {
  124. HTTPManager.Logger.Exception("WebSocketTransport", "OnMessage OnPacket", ex, this.Manager.Context);
  125. }
  126. }
  127. }
  128. /// <summary>
  129. /// WebSocket implementation OnBinary event handler.
  130. /// </summary>
  131. private void OnBinary(WebSocket ws, byte[] data)
  132. {
  133. if (ws != Implementation)
  134. return;
  135. if (HTTPManager.Logger.Level <= BestHTTP.Logger.Loglevels.All)
  136. HTTPManager.Logger.Verbose("WebSocketTransport", "OnBinary", this.Manager.Context);
  137. IncomingPacket packet = IncomingPacket.Empty;
  138. try
  139. {
  140. packet = this.Manager.Parser.Parse(this.Manager, new BufferSegment(data, 0, data.Length));
  141. }
  142. catch (Exception ex)
  143. {
  144. HTTPManager.Logger.Exception("WebSocketTransport", "OnBinary Packet parsing", ex, this.Manager.Context);
  145. }
  146. if (!packet.Equals(IncomingPacket.Empty))
  147. {
  148. try
  149. {
  150. OnPacket(packet);
  151. }
  152. catch (Exception ex)
  153. {
  154. HTTPManager.Logger.Exception("WebSocketTransport", "OnBinary OnPacket", ex, this.Manager.Context);
  155. }
  156. }
  157. }
  158. /// <summary>
  159. /// WebSocket implementation OnError event handler.
  160. /// </summary>
  161. private void OnError(WebSocket ws, string error)
  162. {
  163. if (ws != Implementation)
  164. return;
  165. #if !UNITY_WEBGL || UNITY_EDITOR
  166. if (string.IsNullOrEmpty(error))
  167. {
  168. switch (ws.InternalRequest.State)
  169. {
  170. // The request finished without any problem.
  171. case HTTPRequestStates.Finished:
  172. if (ws.InternalRequest.Response.IsSuccess || ws.InternalRequest.Response.StatusCode == 101)
  173. error = string.Format("Request finished. Status Code: {0} Message: {1}", ws.InternalRequest.Response.StatusCode.ToString(), ws.InternalRequest.Response.Message);
  174. else
  175. error = string.Format("Request Finished Successfully, but the server sent an error. Status Code: {0}-{1} Message: {2}",
  176. ws.InternalRequest.Response.StatusCode,
  177. ws.InternalRequest.Response.Message,
  178. ws.InternalRequest.Response.DataAsText);
  179. break;
  180. // The request finished with an unexpected error. The request's Exception property may contain more info about the error.
  181. case HTTPRequestStates.Error:
  182. error = "Request Finished with Error! : " + ws.InternalRequest.Exception != null ? (ws.InternalRequest.Exception.Message + " " + ws.InternalRequest.Exception.StackTrace) : string.Empty;
  183. break;
  184. // The request aborted, initiated by the user.
  185. case HTTPRequestStates.Aborted:
  186. error = "Request Aborted!";
  187. break;
  188. // Connecting to the server is timed out.
  189. case HTTPRequestStates.ConnectionTimedOut:
  190. error = "Connection Timed Out!";
  191. break;
  192. // The request didn't finished in the given time.
  193. case HTTPRequestStates.TimedOut:
  194. error = "Processing the request Timed Out!";
  195. break;
  196. }
  197. }
  198. #endif
  199. if (Manager.UpgradingTransport != this)
  200. (Manager as IManager).OnTransportError(this, error);
  201. else
  202. Manager.UpgradingTransport = null;
  203. }
  204. /// <summary>
  205. /// WebSocket implementation OnClosed event handler.
  206. /// </summary>
  207. private void OnClosed(WebSocket ws, ushort code, string message)
  208. {
  209. if (ws != Implementation)
  210. return;
  211. HTTPManager.Logger.Information("WebSocketTransport", "OnClosed", this.Manager.Context);
  212. Close();
  213. if (Manager.UpgradingTransport != this)
  214. (Manager as IManager).TryToReconnect();
  215. else
  216. Manager.UpgradingTransport = null;
  217. }
  218. #endregion
  219. #region Packet Sending Implementation
  220. /// <summary>
  221. /// A WebSocket implementation of the packet sending.
  222. /// </summary>
  223. public void Send(OutgoingPacket packet)
  224. {
  225. if (State == TransportStates.Closed ||
  226. State == TransportStates.Paused)
  227. {
  228. HTTPManager.Logger.Information("WebSocketTransport", string.Format("Send - State == {0}, skipping packet sending!", State), this.Manager.Context);
  229. return;
  230. }
  231. if (packet.IsBinary)
  232. Implementation.Send(packet.PayloadData.Data, (ulong)packet.PayloadData.Offset, (ulong)packet.PayloadData.Count);
  233. else
  234. Implementation.Send(packet.Payload);
  235. if (packet.Attachements != null)
  236. for (int i = 0; i < packet.Attachements.Count; ++i)
  237. Implementation.Send(packet.Attachements[i]);
  238. }
  239. /// <summary>
  240. /// A WebSocket implementation of the packet sending.
  241. /// </summary>
  242. public void Send(List<OutgoingPacket> packets)
  243. {
  244. for (int i = 0; i < packets.Count; ++i)
  245. Send(packets[i]);
  246. packets.Clear();
  247. }
  248. #endregion
  249. #region Packet Handling
  250. /// <summary>
  251. /// Will only process packets that need to upgrade. All other packets are passed to the Manager.
  252. /// </summary>
  253. private void OnPacket(IncomingPacket packet)
  254. {
  255. switch (packet.TransportEvent)
  256. {
  257. case TransportEventTypes.Open:
  258. if (this.State != TransportStates.Opening)
  259. HTTPManager.Logger.Warning("WebSocketTransport", "Received 'Open' packet while state is '" + State.ToString() + "'", this.Manager.Context);
  260. else
  261. State = TransportStates.Open;
  262. goto default;
  263. case TransportEventTypes.Pong:
  264. // Answer for a Ping Probe.
  265. if ("probe".Equals(packet.DecodedArg))
  266. {
  267. State = TransportStates.Open;
  268. (Manager as IManager).OnTransportProbed(this);
  269. }
  270. goto default;
  271. default:
  272. if (Manager.UpgradingTransport != this)
  273. (Manager as IManager).OnPacket(packet);
  274. break;
  275. }
  276. }
  277. #endregion
  278. }
  279. }
  280. #endif
  281. #endif