Framework to support multiple workers and a Redis implementation

README.rst

@@ -1,3 +1,14 @@
+Caution!!!
+============
+
+This is an experimental fork of ``gevent-socketio`` that adds support for 
+pluggable backends to create and manage the lifecycle of sockets across multiple 
+workers and implements a Redis-based version of such a backend.
+
+There are significant changes to the original code and it won't be 
+backward-compatible with existing projects. However it should be relatively 
+trivial to switch, if you know what you are doing.
+
 Presentation
 ============
 

examples/django-gunicorn-redis/gunicorn.conf.py

@@ -0,0 +1,26 @@
+import multiprocessing
+import os
+os.environ["GEVENT_RESOLVER"] = "ares" #Resolves some nasty bugs with native socket creation in imports (for example a mobile detection lib reading cache from Redis)
+
+bind = "0.0.0.0:8080"
+workers = multiprocessing.cpu_count() * 2 + 1
+max_requests = 10000
+worker_class = "socketio.sgunicorn.GeventSocketIOWorker"
+preload_app = True
+
+raw_env=[
+         "SOCKET_MANAGER_CLASS=socketio.contrib.redis.socket_manager.RedisSocketManager",
+         "SOCKET_MANAGER_REDIS_HOST=127.0.0.1",
+         "SOCKET_MANAGER_REDIS_PORT=6379",
+         "SOCKET_MANAGER_REDIS_DB=0"
+         ]
+
+
+loglevel = "debug"
+
+
+# this ensures forked processes are patched with psycogreen
+def post_fork(server, worker):
+    os.environ["GEVENT_RESOLVER"] = "ares"
+    from psycogreen.gevent import patch_psycopg
+    patch_psycopg()

examples/django_chat/chat/management/commands/runserver_socketio.py

@@ -51,7 +51,15 @@ def handle(self, addrport="", *args, **options):
             print "SocketIOServer running on %s:%s" % bind
             print
             handler = self.get_handler(*args, **options)
-            server = SocketIOServer(bind, handler, resource="socket.io", policy_server=True)
+            manager_conf = getattr(settings, "SOCKET_MANAGER", None)
+            kw = {
+                  "resource":"socket.io", 
+                  "policy_server":True
+            }
+            if manager_conf:
+                kw["socket_manager_config"] = manager_conf
+                print "SocketManager settings %s" % manager_conf
+            server = SocketIOServer(bind, handler, **kw)
             server.serve_forever()
         except KeyboardInterrupt:
             if RELOAD:

examples/django_chat/chat/sockets.py

@@ -12,34 +12,42 @@ def initialize(self):
         self.logger = logging.getLogger("socketio.chat")
         self.log("Socketio session started")
 
+
     def log(self, message):
         self.logger.info("[{0}] {1}".format(self.socket.sessid, message))
 
     def on_join(self, room):
-        self.room = room
         self.join(room)
         return True
 
     def on_nickname(self, nickname):
         self.log('Nickname: {0}'.format(nickname))
-        self.nicknames.append(nickname)
-        self.socket.session['nickname'] = nickname
+        self.session['nickname'] = nickname
+        nicknames = self.session.get('nicknames', None)#WTH is 'nicknames'?!! 
+        if nicknames is None:
+            nicknames = set()
+        nicknames.add(nickname)
+        self.session['nicknames'] = nicknames
+
         self.broadcast_event('announcement', '%s has connected' % nickname)
-        self.broadcast_event('nicknames', self.nicknames)
+        self.broadcast_event('nicknames', list(nicknames))
         return True, nickname
 
     def recv_disconnect(self):
         # Remove nickname from the list.
         self.log('Disconnected')
-        nickname = self.socket.session['nickname']
-        self.nicknames.remove(nickname)
+        nickname = self.session.get('nickname')
+        if nickname:
+            nicknames = self.session.get('nicknames', None)
+            if nicknames:
+                nicknames.remove(nickname)
+            self.session['nicknames'] = nicknames
         self.broadcast_event('announcement', '%s has disconnected' % nickname)
-        self.broadcast_event('nicknames', self.nicknames)
+        self.broadcast_event('nicknames', list(self.nicknames))
         self.disconnect(silent=True)
         return True
 
-    def on_user_message(self, msg):
+    def on_user_message(self, room, msg):
         self.log('User message: {0}'.format(msg))
-        self.emit_to_room(self.room, 'msg_to_room',
-            self.socket.session['nickname'], msg)
+        self.emit_to_room(room, 'msg_to_room', self.session['nickname'], msg)
         return True

examples/django_chat/chat/static/js/chat.js

@@ -51,7 +51,7 @@ $(function () {
 
     $('#send-message').submit(function () {
 	    message('me', $('#message').val());
-	    socket.emit('user message', $('#message').val());
+	    socket.emit('user message', window.room, $('#message').val());
 	    clear();
 	    $('#lines').get(0).scrollTop = 10000000;
 	    return false;

examples/django_chat/chatproject/settings.py

@@ -82,3 +82,6 @@
     },
 }
 
+SOCKET_MANAGER = {
+                  "class": "socketio.socket_manager.SocketManager"
+                  }

examples/simple_pyramid_chat/chatter2/views.py

@@ -33,7 +33,7 @@ def emit_to_room(self, event, args, room):
                    args=args,
                    endpoint=self.ns_name)
         room_name = self._get_room_name(room)
-        for sessid, socket in self.socket.server.sockets.iteritems():
+        for sessid, socket in self.socket.manager.sockets.iteritems():
             if not hasattr(socket, 'rooms'):
                 continue
             if room_name in socket.rooms: