added a few WebSocket examples

mojolicious · Feb 24, 2012 · fe76875 · fe76875
1 parent 455b8fe
commit fe76875
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
+2.53    2012-02-24 00:00:00
+        - Improved documentation.
+
 2.52    2012-02-24 00:00:00
         - Removed experimental status from config method in Mojo.
         - Renamed send_message method in Mojolicious::Controller to send.

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -549,8 +549,11 @@ Alias for L<Mojo::Transaction/"resume">.
   $ws->send('Hi there!');
   $ws->send('Hi there!' => sub {...});
 
-Send a message or single frame non-blocking via WebSocket, the optional drain
-callback will be invoked once all data has been written.
+Send message or frame non-blocking via WebSocket, the optional drain callback
+will be invoked once all data has been written.
+
+  # Send "Ping" frame
+  $ws->send([1, 0, 0, 0, 9, 'Hello World!']);
 
 =head2 C<server_handshake>
 

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -920,13 +920,16 @@ defaults to rendering an empty C<204> response.
   $c = $c->send('Hi there!');
   $c = $c->send('Hi there!', sub {...});
 
-Send a message or single frame non-blocking via WebSocket, the optional drain
-callback will be invoked once all data has been written. Note that this
-method is EXPERIMENTAL and might change without warning!
+Send message or frame non-blocking via WebSocket, the optional drain callback
+will be invoked once all data has been written. Note that this method is
+EXPERIMENTAL and might change without warning!
 
   # Send JSON object as text frame
   $c->send({text => Mojo::JSON->new->encode({hello => 'world'})});
 
+  # Send "Ping" frame
+  $c->send([1, 0, 0, 0, 9, 'Hello World!']);
+
 =head2 C<session>
 
   my $session = $c->session;

diff --git a/lib/Test/Mojo.pm b/lib/Test/Mojo.pm
@@ -687,8 +687,8 @@ Reset user agent session.
   $t = $t->send_ok('hello');
   $t = $t->send_ok('hello', 'sent successfully');
 
-Send C<WebSocket> message or single frame. Note that this method is
-EXPERIMENTAL and might change without warning!
+Send message or frame via WebSocket. Note that this method is EXPERIMENTAL
+and might change without warning!
 
 =head2 C<status_is>