<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12003] CalendarServer/trunk/twext/application/masterchild.py</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12003">12003</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-11-22 20:36:06 -0800 (Fri, 22 Nov 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Work on the master</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktwextapplicationmasterchildpy">CalendarServer/trunk/twext/application/masterchild.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktwextapplicationmasterchildpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/application/masterchild.py (12002 => 12003)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/application/masterchild.py        2013-11-23 02:27:34 UTC (rev 12002)
+++ CalendarServer/trunk/twext/application/masterchild.py        2013-11-23 04:36:06 UTC (rev 12003)
</span><span class="lines">@@ -30,9 +30,10 @@
</span><span class="cx"> from twisted.application.service import IServiceMaker
</span><span class="cx"> from twisted.application.internet import TCPServer
</span><span class="cx"> from twisted.protocols.policies import WrappingFactory, ProtocolWrapper
</span><del>-
</del><span class="cx"> from twisted.internet.protocol import ServerFactory
</span><span class="cx"> from twisted.internet.protocol import ProcessProtocol
</span><ins>+
+from twext.python.log import Logger
</ins><span class="cx"> from twext.internet.sendfdport import InheritingProtocolFactory
</span><span class="cx"> from twext.internet.sendfdport import InheritedSocketDispatcher
</span><span class="cx"> from twext.internet.sendfdport import IStatusWatcher
</span><span class="lines">@@ -40,22 +41,34 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-class MasterOptions (Options):
-    optParameters = [[
-        #&quot;config&quot;, &quot;f&quot;, DEFAULT_CONFIG_FILE, &quot;Path to configuration file.&quot;
-    ]]
</del><ins>+class MasterOptions(Options):
+    &quot;&quot;&quot;
+    Options for a master process.
+    &quot;&quot;&quot;
</ins><span class="cx"> 
</span><del>-    # def __init__(self, *args, **kwargs):
-    #     super(Options, self).__init__(*args, **kwargs)
</del><span class="cx"> 
</span><span class="cx"> 
</span><ins>+class SpawningInheritingProtocolFactory(InheritingProtocolFactory):
+    def __init__(self, dispatcher, spawningService, description):
+        super(SpawningInheritingProtocolFactory, self).__init__(
+            dispatcher, description
+        )
+        self.spawningService = spawningService
</ins><span class="cx"> 
</span><ins>+
+    def sendSocket(self, socketObject):
+        self.spawningService.socketWillArrive()
+        super(SpawningInheritingProtocolFactory, self).sendSocket(socketObject)
+
+
+
</ins><span class="cx"> @implementer(IServiceMaker)
</span><span class="cx"> class MasterServiceMaker(object):
</span><span class="cx">     def makeService(self, options):
</span><span class="cx">         service = MultiService()
</span><span class="cx"> 
</span><span class="cx">         port = 8000
</span><ins>+        childProtocol = &quot;twext.protocols.echo.EchoProtocol&quot;
</ins><span class="cx"> 
</span><span class="cx">         # Dispatcher
</span><span class="cx">         statusWatcher = StatusWatcher()
</span><span class="lines">@@ -66,8 +79,10 @@
</span><span class="cx">         spawningService.setServiceParent(service)
</span><span class="cx"> 
</span><span class="cx">         # TCP Service
</span><del>-        description = b&quot;&quot;  # UserInfo sent to the dispatcher
-        tcpFactory = InheritingProtocolFactory(dispatcher, description)
</del><ins>+        description = bytes(childProtocol)  # UserInfo sent to the dispatcher
+        tcpFactory = SpawningInheritingProtocolFactory(
+            dispatcher, spawningService, description
+        )
</ins><span class="cx">         tcpService = TCPServer(port, tcpFactory)
</span><span class="cx"> 
</span><span class="cx">         tcpService.setServiceParent(service)
</span><span class="lines">@@ -75,22 +90,22 @@
</span><span class="cx">         return service
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-#########
-# Subclass InheritingProtocolFactory
-# override sendSocket to decide when to spawn a child
</del><span class="cx"> 
</span><ins>+Child = namedtuple(&quot;Child&quot;, (&quot;transport&quot;, &quot;protocol&quot;))
</ins><span class="cx"> 
</span><del>-# @implementer(IServiceMaker)
-# class ChildSpawningServiceMaker(object):
-#     def makeService(self, options):
-#         service = ChildSpawningService(args)
-#         return service
</del><span class="cx"> 
</span><span class="cx"> 
</span><ins>+class ChildSpawningService(Service, object):
+    log = Logger()
</ins><span class="cx"> 
</span><del>-class ChildSpawningService(Service, object):
-    def __init__(self, dispatcher, maxProcessCount=8):
</del><ins>+    def __init__(self, dispatcher, protocolName, maxProcessCount=8):
+        &quot;&quot;&quot;
+        @param protocol: The name of the protocol for the child to use
+            to handle connections.
+        @type protocol: L{str} naming an L{IProtocol} implementer.
+        &quot;&quot;&quot;
</ins><span class="cx">         self.dispatcher = dispatcher
</span><ins>+        self.protocolName = protocolName
</ins><span class="cx">         self.maxProcessCount = maxProcessCount
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -104,7 +119,20 @@
</span><span class="cx">         del(self.children)
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-    def spawnChild(self, arguments):
</del><ins>+    def socketWillArrive(self):
+        &quot;&quot;&quot;
+        This method is where this service makes sure that there are
+        sufficient child processes available to handle additional
+        connections.
+        &quot;&quot;&quot;
+        if len(self.children) == 0:
+            self.spawnChild()
+
+
+    def spawnChild(self):
+        &quot;&quot;&quot;
+        Spawn a child process to handle connections.
+        &quot;&quot;&quot;
</ins><span class="cx">         from twisted.internet import reactor
</span><span class="cx"> 
</span><span class="cx">         inheritedSocket = self.dispatcher.addSocket()
</span><span class="lines">@@ -112,45 +140,86 @@
</span><span class="cx"> 
</span><span class="cx">         processProtocol = ChildProcessProtocol(self, inheritedSocket)
</span><span class="cx"> 
</span><del>-        reactor.spawnProcess(
</del><ins>+        arguments = (
+            sys.executable, b&quot;-c&quot;,
+            b&quot;from twisted.scripts.twistd import run; run()&quot;,
+            b&quot;--inherited-fd&quot;, b&quot;3&quot;,
+            b&quot;--protocol&quot;, self.protocolName,
+        )
+
+        transport = reactor.spawnProcess(
</ins><span class="cx">             processProtocol,
</span><del>-            sys.executable,
-            args=(
-                sys.executable, b&quot;-c&quot;,
-                b&quot;from twisted.scripts.twistd import run; run()&quot;,
-                b&quot;--inherited-fd&quot;, b&quot;3&quot;,
-            ) + tuple(arguments),
-            env={},
</del><ins>+            sys.executable, arguments, env={},
</ins><span class="cx">             childFDs={0: b&quot;w&quot;, 1: b&quot;r&quot;, 2: b&quot;r&quot;, 3: inheritedFD}
</span><span class="cx">         )
</span><span class="cx"> 
</span><del>-        self.children.add(processProtocol)
</del><ins>+        child = Child(transport, processProtocol)
</ins><span class="cx"> 
</span><ins>+        self.log.info(
+            u&quot;Spawned child process ({child.transport.pid}) &quot;
+            u&quot;for protocol {protocol!r}: {arguments}&quot;,
+            child=child, protocol=self.protocolName, arguments=arguments,
+        )
</ins><span class="cx"> 
</span><del>-    def childDidExit(self, child):
-        self.children.remove(child)
-        self.dispatcher.removeSocket(child.inheritedSocket)
</del><ins>+        self.children.add(child)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><ins>+    def childDidExit(self, processProtocol, reason):
+        &quot;&quot;&quot;
+        Called by L{ChildProcessProtocol} to alert this service that a
+        child process has exited.
</ins><span class="cx"> 
</span><ins>+        @param processProtocol: The processProtocol for the child that
+            exited.
+        @type processProtocol: L{ChildProcessProtocol}
+
+        @param reason: The reason that the child exited.
+        @type reason: L{Failure}
+        &quot;&quot;&quot;
+        for child in self.children:
+            if child.protocol == processProtocol:
+                self.log.info(
+                    u&quot;Child process ({child.transport.pid}) exited: &quot;
+                    u&quot;{reason}&quot;,
+                    child=child, reason=reason,
+                )
+                self.children.remove(child)
+                break
+        else:
+            self.log.error(
+                u&quot;No child for for process protocol&quot;,
+                processProtocol=processProtocol
+            )
+
+        try:
+            self.dispatcher.removeSocket(processProtocol.inheritedSocket)
+        except ValueError:
+            self.log.error(
+                u&quot;No socket found for process protocol&quot;,
+                processProtocol=processProtocol
+            )
+
+
+
</ins><span class="cx"> class ChildProcessProtocol(ProcessProtocol, object):
</span><ins>+    log = Logger()
+
</ins><span class="cx">     def __init__(self, service, inheritedSocket):
</span><span class="cx">         self.service = service
</span><span class="cx">         self.inheritedSocket = inheritedSocket
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def outReceived(self, data):
</span><del>-        super(ChildProcessProtocol, self).outReceived(data)
-        # FIXME: log...
</del><ins>+        self.log.info(u&quot;{data}&quot;, data=data)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def errReceived(self, data):
</span><span class="cx">         super(ChildProcessProtocol, self).errReceived(data)
</span><del>-        # FIXME: log...
</del><ins>+        self.log.error(u&quot;{data}&quot;, data=data)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def processExited(self, reason):
</span><del>-        self.service.childDidExit(self)
</del><ins>+        self.service.childDidExit(self, reason)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -262,6 +331,7 @@
</span><span class="cx">     def initialStatus():
</span><span class="cx">         return Status(sentCount=0, ackedCount=0)
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx">     @staticmethod
</span><span class="cx">     def newConnectionStatus(previousStatus):
</span><span class="cx">         return Status(
</span><span class="lines">@@ -269,6 +339,7 @@
</span><span class="cx">             ackedCount=previousStatus.ackedCount,
</span><span class="cx">         )
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx">     @staticmethod
</span><span class="cx">     def statusFromMessage(previousStatus, message):
</span><span class="cx">         if message == b&quot;-&quot;:
</span><span class="lines">@@ -284,6 +355,7 @@
</span><span class="cx">         else:
</span><span class="cx">             raise AssertionError(&quot;Unknown message: {}&quot;.format(message))
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx">     @staticmethod
</span><span class="cx">     def closeCountFromStatus(previousStatus):
</span><span class="cx">         return (
</span><span class="lines">@@ -296,7 +368,4 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-Status = namedtuple(
-    &quot;Status&quot;,
-    (&quot;sentCount&quot;, &quot;ackedCount&quot;)
-)
</del><ins>+Status = namedtuple(&quot;Status&quot;, (&quot;sentCount&quot;, &quot;ackedCount&quot;))
</ins></span></pre>
</div>
</div>

</body>
</html>