about summary refs log tree commit homepage
path: root/lib/PublicInbox/Mbox.pm
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-01-07 09:09:51 +0000
committerEric Wong <e@80x24.org>2019-01-09 11:44:52 +0000
commita9cab9c477b74b3b828c26aa64e70d88c9d6744c (patch)
treef0205f3253aad322c6a7e074b3939d1d345e1b56 /lib/PublicInbox/Mbox.pm
parente683624b96fdc2587a2e45895d22b373c8a6413b (diff)
downloadpublic-inbox-a9cab9c477b74b3b828c26aa64e70d88c9d6744c.tar.gz
Hopefully this helps people familiarize themselves with
the source code.
Diffstat (limited to 'lib/PublicInbox/Mbox.pm')
-rw-r--r--lib/PublicInbox/Mbox.pm8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm
index 11b23022..78dbe27e 100644
--- a/lib/PublicInbox/Mbox.pm
+++ b/lib/PublicInbox/Mbox.pm
@@ -1,8 +1,12 @@
 # Copyright (C) 2015-2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
-# Streaming interface for formatting messages as an mboxrd.
-# Used by the web interface
+# Streaming (via getline) interface for formatting messages as an mboxrd.
+# Used by the PSGI web interface.
+#
+# public-inbox-httpd favors "getline" response bodies to take a
+# "pull"-based approach to feeding slow clients (as opposed to a
+# more common "push" model)
 package PublicInbox::Mbox;
 use strict;
 use warnings;