From: bfis <b.fis@cern.ch>
Date: Mon, 11 Jan 2021 16:49:33 +0000 (+0100)
Subject: Add comment explaining workaround
X-Git-Tag: v6.2.0b1~54^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2970%2Fhead;p=thirdparty%2Ftornado.git

Add comment explaining workaround
---

diff --git a/tornado/iostream.py b/tornado/iostream.py
index 51a348c2c..7610bce4f 100644
--- a/tornado/iostream.py
+++ b/tornado/iostream.py
@@ -1587,6 +1587,9 @@ class SSLIOStream(IOStream):
                 # to read (attempting to read may or may not raise an exception
                 # depending on the SSL version)
                 return None
+            # clip buffer size at 1GB since SSL sockets only support upto 2GB
+            # this change in behaviour is transparent, since the function is
+            # already expected to (possibly) read less than the provided buffer
             if len(buf) >> 30:
                 buf = memoryview(buf)[: 1 << 30]
             try: