summaryrefslogtreecommitdiff
path: root/doc/api/tls.markdown
diff options
context:
space:
mode:
authorFedor Indutny <fedor.indutny@gmail.com>2014-01-17 18:46:49 +0000
committerFedor Indutny <fedor.indutny@gmail.com>2014-01-20 20:39:57 +0400
commit7f9b01509f28de5888a45b8b1af5667e507a0c94 (patch)
tree3d1e436601a0badaeabe49a4939a686b9d48a20b /doc/api/tls.markdown
parent023f0a3122d54e3f331f32f5cfe0cb0df9e8f131 (diff)
downloadnode-new-7f9b01509f28de5888a45b8b1af5667e507a0c94.tar.gz
lib: introduce `.setMaxSendFragment(size)`
fix #6889
Diffstat (limited to 'doc/api/tls.markdown')
-rw-r--r--doc/api/tls.markdown12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
index 97c78fea8f..cf7a87fa2a 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.markdown
@@ -634,6 +634,18 @@ has been established.
ANOTHER NOTE: When running as the server, socket will be destroyed
with an error after `handshakeTimeout` timeout.
+### tlsSocket.setMaxSendFragment(size)
+
+Set maximum TLS fragment size (default and maximum value is: `16384`, minimum
+is: `512`). Returns `true` on success, `false` otherwise.
+
+Smaller fragment size decreases buffering latency on the client: large
+fragments are buffered by the TLS layer until the entire fragment is received
+and its integrity is verified; large fragments can span multiple roundtrips,
+and their processing can be delayed due to packet loss or reordering. However,
+smaller fragments add extra TLS framing bytes and CPU overhead, which may
+decrease overall server throughput.
+
### tlsSocket.address()
Returns the bound address, the address family name and port of the