aboutsummaryrefslogtreecommitdiff
path: root/doc/stream.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/stream.html')
-rw-r--r--doc/stream.html8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/stream.html b/doc/stream.html
index b88cbb5..585ad18 100644
--- a/doc/stream.html
+++ b/doc/stream.html
@@ -69,15 +69,15 @@ callback receives successive chunks of downloaded data.
69<tt>Chunk</tt> contains the current chunk of data. 69<tt>Chunk</tt> contains the current chunk of data.
70When the transmission is over, the function is called with an 70When the transmission is over, the function is called with an
71empty string (i.e.&nbsp;<tt>""</tt>) as the <tt>chunk</tt>. 71empty string (i.e.&nbsp;<tt>""</tt>) as the <tt>chunk</tt>.
72If an error occurs, the function receives <tt>nil</tt> 72If an error occurs, the function receives <b><tt>nil</tt></b>
73as <tt>chunk</tt> and an error message in <tt>err</tt>. 73as <tt>chunk</tt> and an error message in <tt>err</tt>.
74</p> 74</p>
75 75
76<p class=return> 76<p class=return>
77The callback can abort transmission by returning <tt>nil</tt> as its first 77The callback can abort transmission by returning <b><tt>nil</tt></b> as its first
78return value, and an optional error message as the 78return value, and an optional error message as the
79second return value. If the application wants to continue receiving 79second return value. If the application wants to continue receiving
80data, the function should return non-<tt>nil</tt> as it's first return 80data, the function should return non-<b><tt>nil</tt></b> as it's first return
81value. In this case, the function can optionally return a 81value. In this case, the function can optionally return a
82new callback function, to replace itself, as the second return value. 82new callback function, to replace itself, as the second return value.
83</p> 83</p>
@@ -121,7 +121,7 @@ library needs more data to be sent.
121Each time the callback is called, it should return the next chunk of data. It 121Each time the callback is called, it should return the next chunk of data. It
122can optionally return, as it's second return value, a new callback to replace 122can optionally return, as it's second return value, a new callback to replace
123itself. The callback can abort the process at any time by returning 123itself. The callback can abort the process at any time by returning
124<tt>nil</tt> followed by an optional error message. 124<b><tt>nil</tt></b> followed by an optional error message.
125</p> 125</p>
126 126
127<p class=note> 127<p class=note>