added GeventWebsocketClient::receive_nb() non-blocking receive method

coderfi · coderfi · commit ef6b1a5f1b54 · 2014-07-13T00:14:53.000-07:00
added some documentation to receive() and receive_nb()
diff --git a/flask_uwsgi_websocket/_gevent.py b/flask_uwsgi_websocket/_gevent.py
@@ -2,7 +2,7 @@
 
 from gevent import killall, sleep, spawn, wait
 from gevent.event import Event
-from gevent.queue import Queue
+from gevent.queue import Queue, Empty
 from gevent.select import select
 from gevent.monkey import patch_all; patch_all()
 import uuid
@@ -29,8 +29,21 @@ def send(self, message):
         self.send_event.set()
 
     def receive(self):
+        """ Receives a message from the websocket (blocking).
+        :return the message
+        """
         return self.recv_queue.get()
 
+    def receive_nb(self):
+        """ Receives a message from the websocket (non-blocking).
+        :return the message or None if no message was available
+                immediately
+        """
+        try:
+            return self.recv_queue.get_nowait()
+        except Empty:
+            return None
+
     def close(self):
         self.connected = False
 
diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 
 setup(
     name='Flask-uWSGI-WebSocket',
-    version='0.2.5.1',
+    version='0.2.5.2',
     url='https://github.com/zeekay/flask-uwsgi-websocket',
     license='MIT',
     author='Zach Kelling',
