Adding a bit of documentation for the .on_no_data callback

voloko · May 11, 2012 · b850806 · b850806
1 parent 6650484
commit b850806
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.markdown b/README.markdown
@@ -32,6 +32,11 @@ JSON format only.
       stream.on_max_reconnects do |timeout, retries|
         # Something is wrong on your side. Send yourself an email.
       end
+
+      stream.on_no_data do
+        # Twitter has stopped sending any data on the currently active
+        # connection, reconnecting is probably in order
+      end
     }
 
 

diff --git a/lib/twitter/json_stream.rb b/lib/twitter/json_stream.rb
@@ -90,6 +90,8 @@ def on_reconnect &block
       @reconnect_callback = block
     end
 
+    # Called when no data has been received for NO_DATA_TIMEOUT seconds.
+    # Reconnecting is probably in order as per the Twitter recommendations
     def on_no_data &block
       @no_data_callback = block
     end