mention non-blocking write behavior on all layers

mojolicious · Oct 14, 2011 · 2633917 · 2633917
1 parent e3a452e
commit 2633917
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -628,16 +628,16 @@ Note that this method is EXPERIMENTAL and might change without warning!
   $content->write('Hello!');
   $content->write('Hello!', sub {...});
 
-Write dynamic content, the optional drain callback will be invoked once all
-data has been written.
+Write dynamic content non-blocking, the optional drain callback will be
+invoked once all data has been written.
 
 =head2 C<write_chunk>
 
   $content->write_chunk('Hello!');
   $content->write_chunk('Hello!', sub {...});
 
-Write chunked content, the optional drain callback will be invoked once all
-data has been written.
+Write dynamic content non-blocking with the C<chunked> transfer encoding, the
+optional drain callback will be invoked once all data has been written.
 
 =head1 SEE ALSO
 

diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -845,16 +845,16 @@ HTTP version of message.
   $message->write('Hello!');
   $message->write('Hello!', sub {...});
 
-Write dynamic content, the optional drain callback will be invoked once all
-data has been written.
+Write dynamic content non-blocking, the optional drain callback will be
+invoked once all data has been written.
 
 =head2 C<write_chunk>
 
   $message->write_chunk('Hello!');
   $message->write_chunk('Hello!', sub {...});
 
-Write chunked content, the optional drain callback will be invoked once all
-data has been written.
+Write dynamic content non-blocking with the C<chunked> transfer encoding, the
+optional drain callback will be invoked once all data has been written.
 
 =head1 SEE ALSO
 

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -512,8 +512,10 @@ Resume transaction.
   $ws->send_message([$bytes]);
   $ws->send_message([$bytes], sub {...});
 
-Send a message over the WebSocket, encoding and framing will be handled
-transparently.
+Send a message non-blocking via WebSocket, encoding and framing will be
+handled transparently.
+The optional drain callback will be invoked once all data has been written to
+the kernel send buffer or equivalent.
 
 =head2 C<server_handshake>
 

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -947,8 +947,10 @@ Note that this method is EXPERIMENTAL and might change without warning!
   $c = $c->send_message([$bytes]);
   $c = $c->send_message([$bytes], sub {...});
 
-Send a message non-blocking via WebSocket, only works if a WebSocket
-connection has been established.
+Send a message non-blocking via WebSocket, encoding and framing will be
+handled transparently.
+The optional drain callback will be invoked once all data has been written to
+the kernel send buffer or equivalent.
 Note that this method is EXPERIMENTAL and might change without warning!
 
 =head2 C<session>