From 1679a62c2cd2cdfed10a0f699cbc29e123dcb4e2 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Fri, 29 Aug 2025 21:45:42 +0000
Subject:  Add realtime and norealtime options, cork/uncork responses

---
 doc/tipidee.conf.html | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

(limited to 'doc')

diff --git a/doc/tipidee.conf.html b/doc/tipidee.conf.html
index f7753da..581b05f 100644
--- a/doc/tipidee.conf.html
+++ b/doc/tipidee.conf.html
@@ -786,6 +786,43 @@ data into records; in that case, autochunk is not needed and only brings
 a small performance penalty. </li>
 </ul>
 
+<div id="realtime">
+<h4> <tt>realtime</tt> </h4>
+</div>
+
+<p>
+ <code> realtime <em>directory</em> </code> <br>
+ <code> realtime <em>file</em> </code>
+</p>
+
+<ul>
+ <li> This directive is useful if <em>file</em> is actually a resource providing
+a large amount of content that you want to serve to the client with as little
+latency as possible, even if it means sacrificing a little throughput. If the
+system's TCP stack supports the functionality, it will minimize the delays in the
+stack so the data is sent to the client as soon as it becomes available, without
+trying to optimizing sending buffers or anything. </li>
+ <li> It is generally not recommended; you should leave that option disabled
+(which is the default). But if you have a resource that benefits from real-time
+transmission (e.g. a streaming service) then you might want to set the option for
+this resource. </li>
+</ul>
+
+<div id="norealtime">
+<h4> <tt>norealtime</tt> </h4>
+</div>
+
+<p>
+ <code> norealtime <em>directory</em> </code> <br>
+ <code> norealtime <em>file</em> </code>
+</p>
+
+<ul>
+ <li> This is the opposite, saying that content streamed from resources under
+<em>directory</em>, or specific script <em>file</em>, will <em>not</em>
+manipulate the TCP stack to send the content in real time. </li>
+</ul>
+
 <div id="file-type">
 <h4> <tt>file-type</tt> </h4>
 </div>
-- 
cgit v1.3.1