renamed receive_nb() to receive_nowait() clarified usage

receive_nowait() raises gevent.empty.Queue

Author: coderfi

README.rst

@@ -138,9 +138,13 @@ Automatically performs WebSocket handshake and passes a ``GeventWebSocketClient`
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 WebSocket client abstraction with fully non-blocking methods.
 
+receive() and receive_nowait() differs in that receive_nowait()
+will raise a ``gevent.queue.Empty`` exception immediately
+if there is no message available.
+
 ``receive()``
 
-``receive_nb()``
+``receive_nowait()``
 
 ``send(msg)``
 

flask_uwsgi_websocket/_gevent.py

@@ -29,20 +29,21 @@ def send(self, message):
         self.send_event.set()
 
     def receive(self):
-        """ Receives a message from the websocket (blocking).
+        """ Receives a message from the websocket.
+        Although the underlying bytes are received via non blocking i/o,
+        this method will block if there are no waiting messages.
         :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
+    def receive_nowait(self):
+        """ Receives a message from the websocket.
+        This differs from the receive() method in that, if there are
+        no waiting messages, this method will quickly return.
+        :return the messag
+        :raise gevent.queue.Empty if no message was immediately available
         """
-        try:
-            return self.recv_queue.get_nowait()
-        except Empty:
-            return None
+        return self.recv_queue.get_nowait()
 
     def close(self):
         self.connected = False

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name='Flask-uWSGI-WebSocket',
-    version='0.2.5.2',
+    version='0.2.5.3',
     url='https://github.com/zeekay/flask-uwsgi-websocket',
     license='MIT',
     author='Zach Kelling',