From f57db12c09eb85303da2c1ed727e25cbbe392843 Mon Sep 17 00:00:00 2001
From: "nicolas.dorier" <nicolas.dorier@gmail.com>
Date: Thu, 9 Apr 2020 18:56:30 +0900
Subject: [PATCH] Document downside of socks proxy

---
 BTCPayServer/HostedServices/Socks5HttpProxyServer.cs | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/BTCPayServer/HostedServices/Socks5HttpProxyServer.cs b/BTCPayServer/HostedServices/Socks5HttpProxyServer.cs
index 2e8713391..73f16e4e5 100644
--- a/BTCPayServer/HostedServices/Socks5HttpProxyServer.cs
+++ b/BTCPayServer/HostedServices/Socks5HttpProxyServer.cs
@@ -18,7 +18,13 @@ using NBitcoin.Socks;
 
 namespace BTCPayServer.HostedServices
 {
-    // Our implementation follow https://devblogs.microsoft.com/dotnet/system-io-pipelines-high-performance-io-in-net/
+    
+    /// <summary>
+    /// This is a very simple Socks HTTP proxy, that can be used through HttpClient.WebProxy
+    /// However, it only supports a single request/response, so the client must specify Connection: close to not
+    /// reuse the TCP connection to the proxy for another requests. 
+    /// Inspired from https://devblogs.microsoft.com/dotnet/system-io-pipelines-high-performance-io-in-net/
+    /// </summary>
     public class Socks5HttpProxyServer : IHostedService
     {
         class ProxyConnection