Changeset 487

Timestamp:

08/12/08 09:34:09 (5 months ago)

Author:

heyadayo

Message:

Added server-side configurable ping timeouts/intervals that are propogated to the client at runtime; the client abides these timeouts by triggering onclose after the specified timeout. Closes tickets 21, 42, and 43

Location:

trunk/daemon

Files:

• orbited-debug.cfg (modified) (2 diffs)
• orbited.cfg (modified) (1 diff)
• orbited/cometsession.py (modified) (4 diffs)
• orbited/config.py (modified) (1 diff)
• orbited/proxy.py (modified) (2 diffs)
• orbited/static/Orbited.js (modified) (7 diffs)

trunk/daemon/orbited-debug.cfg

@@ -2 +2 @@
 reactor=epoll
 proxy.enabled=1
+session.ping_interval = 5
+session.ping_timeout = 5
 
 [listen]
@@ -19 +21 @@
 * -> localhost:6163
 * -> localhost:7
-localhost:8001 -> localhost:6667
+* -> localhost:6667
 
 [logging]

trunk/daemon/orbited.cfg

@@ -3 +3 @@
 #reactor=epoll
 proxy.enabled=1
+session.ping_interval = 40
+session.ping_timeout = 30
 
 [listen]

trunk/daemon/orbited/cometsession.py

@@ -140 +140 @@
     hostHeader = property(lambda s: s.transportProtocol.hostHeader)
     
+    def _get_pingTimeout(self):
+        return self.transportProtocol._pingTimeout
+    
+    def _get_pingInterval(self):
+        return self.transportProtocol._pingInterval
+    
+    def _set_pingTimeout(self, v):
+        self.transportProtocol.pingTimeout = v
+        self.transportProtocol.send(TCPOption('pingTimeout', v))
+        
+    def _set_pingInterval(self, v):
+        self.transportProtocol.pingInterval = v
+        self.transportProtocol.send(TCPOption('pingInterval', v))
+        
+    # Determines timeout interval after ping has been sent
+    pingTimeout = property(_get_pingTimeout, _set_pingTimeout)
+    # Determines interval to wait before sending a ping
+    pingInterval = property(_get_pingInterval, _set_pingInterval)
+    
+    
 class TCPConnectionResource(resource.Resource):
-
+    pingTimeout = 30
+    pingInterval = 30
     logger = logging.get_logger('orbited.cometsession.TCPConnectionResource')
-
-    # Determines timeout interval after ping has been sent
-    pingTimeout = 40
-    # Determines interval to wait before sending a ping
-    # since the last time we heard from the client.
-    pingInterval = 40
 
     def __init__(self, root, key, peer, host, hostHeader, **options):
@@ -381 +396 @@
         elif isinstance(data, TCPClose):
             self.cometTransport.sendPacket('close', str(packetId))
+        elif isinstance(data, TCPOption):
+            self.cometTransport.sendPacket('opt', str(packetId), data.payload)
         else:
             self.cometTransport.sendPacket('data', str(packetId), base64.b64encode(data))
@@ -392 +409 @@
 #        self.cometTransport.sendPacket('id', ackId)
         
+
+    
+
+        
+        
 class TCPPing(object):
     pass
@@ -398 +420 @@
     pass
 
+class TCPOption(object):
+    def __init__(self, name, val):
+        self.payload = str(name) + ',' + str(val)
+        
 class TCPResource(resource.Resource):
     

trunk/daemon/orbited/config.py

@@ -10 +10 @@
         #'proxy.enabled': '1',
 
-        'pid.location': '/tmp/orbited.pid'
+        'pid.location': '/tmp/orbited.pid',
+        'session.ping_interval': '30',
+        'session.ping_timeout': '30'
     },
 

trunk/daemon/orbited/proxy.py

@@ -12 +12 @@
     'Unauthorized': 106,
 }
+pingTimeout  = int(config.map['[global]']['session.ping_timeout'])
+pingInterval = int(config.map['[global]']['session.ping_interval'])
+
 
 class ProxyIncomingProtocol(Protocol):
@@ -23 +26 @@
     def connectionMade(self):
         # TODO: add handshake timer
+        self.transport.pingTimeout = pingTimeout
+        self.transport.pingInterval = pingInterval
         self.logger.debug("connectionMade")
         self.state = 'handshake'

trunk/daemon/orbited/static/Orbited.js

@@ -350 +350 @@
     var handshakeTimer = null;
     var cometTransport = null;
+    var pingInterval = 30000;
+    var pingTimeout = 30000;
+    var timeoutTimer = null;
     var lastPacketId = 0
     var sending = false;
@@ -376 +379 @@
                     sessionKey = xhr.responseText;
 ;;;                 self.logger.debug('session key is: ', sessionKey)
+                    resetTimeout();
                     sessionUrl = new Orbited.URL(_url)
                     // START new URL way
@@ -524 +528 @@
                         break;                    
                 }
-        }
+                break;
+            case 'opt':
+                var args = frame.data.split(',')
+                switch(args[0]) {
+                    case 'pingTimeout':
+                        pingTimeout = parseInt(args[1])*1000
+                        break
+                    case 'pingInterval':
+                        pingInterval = parseInt(args[1])*1000
+                        break;
+                    default:
+;;;                     self.logger.warn('unknown opt key', args[0])
+                        break;
+                }
+        }
+        resetTimeout();
     }
     var transportOnClose = function() {
@@ -606 +625 @@
     var doClose = function(code) {
 ;;;     self.logger.debug('doClose', code)
+        unsetTimeout();
         self.readyState = self.READY_STATE_CLOSED;
         cometTransport.onReadFrame = function() {}
@@ -615 +635 @@
         self.onclose(code);
 
+    }
+
+    var resetTimeout = function() {
+        unsetTimeout();
+        timeoutTimer = window.setTimeout(timedOut, pingInterval + pingTimeout);
+    }
+    var unsetTimeout = function() {
+        window.clearTimeout(timeoutTimer);
+
+    }
+    var timedOut = function() {
+        doClose(Orbited.Errors.ConnectionTimeout)
     }
 };
@@ -1089 +1121 @@
                         break;
                     case 4:
+                        var doReconnect = true;
                         try {
-                            xhr.status
+                            if (xhr.status === null) {
+                                doReconnect = true;
+                            }
+                            else {
+                                doReconnect = false;
+                            }
                         }
                         catch(e) {
+                        }
+                        if (doReconnect) {
                             // Expoential backoff: Every time we fail to 
                             // reconnect, double the interval.
@@ -1099 +1139 @@
 //                            self.logger.debug('retryInterval', retryInterval)
                             window.clearTimeout(heartbeatTimer);
-                            window.setTimeout(reconnect, retryInterval)
+                            retryTimer = window.setTimeout(reconnect, retryInterval)
                             return;
                         }
-
                         switch(xhr.status) {
                             case 200: