Support for Server Name Indication

PingPong.cs

@@ -9,86 +9,40 @@
 
 namespace net.vieapps.Components.WebSockets
 {
-	/// <summary>
-	/// Pong EventArgs
-	/// </summary>
-	internal class PongEventArgs : EventArgs
-	{
-		/// <summary>
-		/// The data extracted from a Pong WebSocket frame
-		/// </summary>
-		public ArraySegment<byte> Payload { get; private set; }
-
-		/// <summary>
-		/// Initialises a new instance of the PongEventArgs class
-		/// </summary>
-		/// <param name="payload">The pong payload must be 125 bytes or less (can be zero bytes)</param>
-		public PongEventArgs(ArraySegment<byte> payload) => this.Payload = payload;
-	}
-
-	// --------------------------------------------------
-
-	/// <summary>
-	/// Ping Pong Manager used to facilitate ping pong WebSocket messages
-	/// </summary>
-	internal interface IPingPongManager
-	{
-		/// <summary>
-		/// Raised when a Pong frame is received
-		/// </summary>
-		event EventHandler<PongEventArgs> Pong;
-
-		/// <summary>
-		/// Sends a ping frame
-		/// </summary>
-		/// <param name="payload">The payload (must be 125 bytes of less)</param>
-		/// <param name="cancellation">The cancellation token</param>
-		Task SendPingAsync(ArraySegment<byte> payload, CancellationToken cancellation = default(CancellationToken));
-	}
-
-	// --------------------------------------------------
-
-	/// <summary>
-	/// Ping Pong Manager used to facilitate ping pong WebSocket messages
-	/// </summary>
-	internal class PingPongManager : IPingPongManager
+	internal class PingPongManager
 	{
 		readonly WebSocketImplementation _websocket;
-		readonly Task _pingTask;
 		readonly CancellationToken _cancellationToken;
-		readonly Stopwatch _stopwatch;
-		long _pingSentTicks;
-
-		/// <summary>
-		/// Raised when a Pong frame is received
-		/// </summary>
-		public event EventHandler<PongEventArgs> Pong;
+		readonly Action<ManagedWebSocket, byte[]> _onPong;
+		readonly Func<ManagedWebSocket, byte[], byte[]> _getPongPayload;
+		readonly Func<ManagedWebSocket, byte[]> _getPingPayload;
+		long _pingTimestamp = 0;
 
-		/// <summary>
-		/// Initialises a new instance of the PingPongManager to facilitate ping pong WebSocket messages.
-		/// </summary>
-		/// <param name="websocket">The WebSocket instance used to listen to ping messages and send pong messages</param>
-		/// <param name="cancellationToken">The token used to cancel a pending ping send AND the automatic sending of ping messages if KeepAliveInterval is positive</param>
-		public PingPongManager(WebSocketImplementation websocket, CancellationToken cancellationToken)
+		public PingPongManager(WebSocketImplementation websocket, WebSocketOptions options, CancellationToken cancellationToken)
 		{
 			this._websocket = websocket;
-			this._websocket.Pong += this.DoPong;
 			this._cancellationToken = cancellationToken;
-			this._stopwatch = Stopwatch.StartNew();
-			this._pingTask = Task.Run(this.DoPingAsync);
+			this._getPongPayload = options.GetPongPayload;
+			this._onPong = options.OnPong;
+			if (this._websocket.KeepAliveInterval != TimeSpan.Zero)
+			{
+				this._getPingPayload = options.GetPingPayload;
+				Task.Run(this.SendPingAsync).ConfigureAwait(false);
+			}
+		}
+
+		public void OnPong(byte[] pong)
+		{
+			this._pingTimestamp = 0;
+			this._onPong?.Invoke(this._websocket, pong);
 		}
 
-		/// <summary>
-		/// Sends a ping frame
-		/// </summary>
-		/// <param name="payload">The payload (must be 125 bytes of less)</param>
-		/// <param name="cancellationToken">The cancellation token</param>
-		public Task SendPingAsync(ArraySegment<byte> payload, CancellationToken cancellationToken = default(CancellationToken))
-			=> this._websocket.SendPingAsync(payload, cancellationToken);
+		public Task SendPongAsync(byte[] ping)
+			=> this._websocket.SendPongAsync((this._getPongPayload?.Invoke(this._websocket, ping) ?? ping).ToArraySegment(), this._cancellationToken);
 
-		async Task DoPingAsync()
+		public async Task SendPingAsync()
 		{
-			Events.Log.PingPongManagerStarted(this._websocket.ID, (int)this._websocket.KeepAliveInterval.TotalSeconds);
+			Events.Log.PingPongManagerStarted(this._websocket.ID, this._websocket.KeepAliveInterval.TotalSeconds.CastAs<int>());
 			try
 			{
 				while (!this._cancellationToken.IsCancellationRequested)
@@ -97,30 +51,19 @@ async Task DoPingAsync()
 					if (this._websocket.State != WebSocketState.Open)
 						break;
 
-					if (this._pingSentTicks != 0)
+					if (this._pingTimestamp != 0)
 					{
 						Events.Log.KeepAliveIntervalExpired(this._websocket.ID, (int)this._websocket.KeepAliveInterval.TotalSeconds);
-						await this._websocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"No Pong message received in response to a Ping after KeepAliveInterval ({this._websocket.KeepAliveInterval})", this._cancellationToken).ConfigureAwait(false);
+						await this._websocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"No PONG message received in response to a PING message after keep-alive interval ({this._websocket.KeepAliveInterval})", this._cancellationToken).ConfigureAwait(false);
 						break;
 					}
 
-					this._pingSentTicks = this._stopwatch.Elapsed.Ticks;
-					await this.SendPingAsync(this._pingSentTicks.ToArraySegment(), this._cancellationToken).ConfigureAwait(false);
+					this._pingTimestamp = DateTime.Now.ToUnixTimestamp();
+					await this._websocket.SendPingAsync((this._getPingPayload?.Invoke(this._websocket) ?? this._pingTimestamp.ToBytes()).ToArraySegment(), this._cancellationToken).ConfigureAwait(false);
 				}
 			}
-			catch (OperationCanceledException)
-			{
-				// normal, do nothing
-			}
+			catch { }
 			Events.Log.PingPongManagerEnded(this._websocket.ID);
 		}
-
-		protected virtual void OnPong(PongEventArgs args) => this.Pong?.Invoke(this, args);
-
-		void DoPong(object sender, PongEventArgs arg)
-		{
-			this._pingSentTicks = 0;
-			this.OnPong(arg);
-		}
 	}
 }

README.md

@@ -67,6 +67,9 @@ public EndPoint LocalEndPoint { get; }
 
 // Extra information
 public Dictionary<string, object> Extra { get; }
+
+// Headers information
+public Dictionary<string, string> Headers { get; }
 ```
 
 ## Fly on the sky with Event-liked driven
@@ -117,8 +120,8 @@ var websocket = new WebSocket
 And this class has some methods for working on both side of client and server role:
 
 ```csharp
-void Connect(Uri uri, WebSocketOptions options, Action<ManagedWebSocket> onSuccess, Action<Exception> onFailed);
-void StartListen(int port, X509Certificate2 certificate, Action onSuccess, Action<Exception> onFailed);
+void Connect(Uri uri, WebSocketOptions options, Action<ManagedWebSocket> onSuccess, Action<Exception> onFailure);
+void StartListen(int port, X509Certificate2 certificate, Action onSuccess, Action<Exception> onFailure, Func<ManagedWebSocket, byte[]> getPingPayload, Func<ManagedWebSocket, byte[], byte[]> getPongPayload, Action<ManagedWebSocket, byte[]> onPong);
 void StopListen();
 ```
 
@@ -149,7 +152,7 @@ websocket.StartListen();
 
 Want to have a free SSL certificate? Take a look at [Let's Encrypt](https://letsencrypt.org/).
 
-Special: A simple tool named [lets-encrypt-win-simple](https://github.com/PKISharp/win-acme) will help your IIS works with Let's Encrypt very well.
+Special: A simple tool named [win-acme](https://github.com/PKISharp/win-acme) will help your IIS works with Let's Encrypt very well.
 
 ### SubProtocol Negotiation
 
@@ -185,7 +188,7 @@ When integrate this component with your app that hosted by ASP.NET / ASP.NET Cor
 then the method **WrapAsync** is here to help. This method will return a task that run a process for receiving messages from this WebSocket connection.
 
 ```csharp
-Task WrapAsync(System.Net.WebSockets.WebSocket webSocket, Uri requestUri, EndPoint remoteEndPoint, EndPoint localEndPoint, string userAgent, string urlReferrer, string headers, string cookies, Action<ManagedWebSocket> onSuccess);
+Task WrapAsync(System.Net.WebSockets.WebSocket webSocket, Uri requestUri, EndPoint remoteEndPoint, EndPoint localEndPoint, Dictionary<string, string> headers, Action<ManagedWebSocket> onSuccess);
 ```
 
 And might be you need an extension method to wrap an existing WebSocket connection, then take a look at some lines of code below:
@@ -316,7 +319,7 @@ bool CloseWebSocket(ManagedWebSocket websocket, WebSocketCloseStatus closeStatus
 
 Our prefers:
 - [Microsoft.Extensions.Logging.Console](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Console): live logs
-- [Serilog.Extensions.Logging.File](https://www.nuget.org/packages/Serilog.Extensions.Logging.File): rolling log files (by date) - high performance, and very simple to use
+- [Serilog.Extensions.Logging.File](https://www.nuget.org/packages/Serilog.Extensions.Logging.File): rolling log files (by hour or date) - high performance, and very simple to use
 
 ### Namespaces
 

VIEApps.Components.WebSockets.csproj

@@ -9,24 +9,24 @@
 		<AssemblyTitle>VIEApps NGX WebSockets</AssemblyTitle>
 		<SignAssembly>false</SignAssembly>
 		<AssemblyOriginatorKeyFile>../VIEApps.Components.snk</AssemblyOriginatorKeyFile>
-		<AssemblyVersion>10.2.1903.1</AssemblyVersion>
-		<FileVersion>10.2.1903.1</FileVersion>
-		<InformationalVersion>v10.2.netstandard-2+rev:2019.03.01-latest.components-ignore.cert.errors</InformationalVersion>
+		<AssemblyVersion>10.2.1906.2</AssemblyVersion>
+		<FileVersion>10.2.1906.2</FileVersion>
+		<InformationalVersion>v10.2.netstandard-2+rev:2019.06.12-async.close</InformationalVersion>
 		<Product>VIEApps NGX</Product>
 		<Company>VIEApps.net</Company>
 		<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
 		<PackageId>VIEApps.Components.WebSockets</PackageId>
-		<Version>10.2.1903.1</Version>
+		<Version>10.2.1906.2</Version>
 		<Title>VIEApps NGX WebSockets</Title>
 		<Description>High performance WebSocket on .NET Standard 2.0 (both server and client - standalone or wrapper of System.Net.WebSockets.WebSocket)</Description>
 		<Authors>VIEApps.net</Authors>
 		<Copyright>© 2019 VIEApps.net</Copyright>
 		<PackageLicense>LICENSE.md</PackageLicense>
 		<PackageOutputPath>..\</PackageOutputPath>
 		<PackageTags>websocket;websockets;websocket-client;websocket-server;websocket-wrapper;vieapps;vieapps.components</PackageTags>
-		<PackageReleaseNotes>Upgrade to latest components, add options to ignore remote certificate errors (support for client certificates)</PackageReleaseNotes>
+		<PackageReleaseNotes>Improvement: add async close methods</PackageReleaseNotes>
+		<PackageProjectUrl>https://vieapps.net/</PackageProjectUrl>
 		<PackageIconUrl>https://github.com/vieapps/Components.Utility/raw/master/logo.png</PackageIconUrl>
-		<PackageProjectUrl>https://github.com/vieapps/Components.WebSockets</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/vieapps/Components.WebSockets</RepositoryUrl>
 	</PropertyGroup>
 
@@ -39,7 +39,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="VIEApps.Components.Utility" Version="10.2.1903.1" />
+		<PackageReference Include="VIEApps.Components.Utility" Version="10.2.1906.2" />
 	</ItemGroup>
 
 </Project>