From a3531957f485034996b6aab062495b8766c5efb7 Mon Sep 17 00:00:00 2001
From: Dave Collins <davec@conformal.com>
Date: Fri, 9 Aug 2013 14:32:22 -0500
Subject: [PATCH] Rework server startup and shutdown sequence.

The commit reworks the server statup and shutdown sequence to ensure the
server can always shutdown cleanly.  The peer code depends on being able
to send messages to the address and block managers, so they need to have
their lifecycle tied to the peer handler to prevent issues with
asynchronous shutdown order.
---
 server.go | 39 ++++++++++++++++++++++++++++++---------
 1 file changed, 30 insertions(+), 9 deletions(-)

diff --git a/server.go b/server.go
index 7895f996a..0aaf45332 100644
--- a/server.go
+++ b/server.go
@@ -184,6 +184,14 @@ func (s *server) listenHandler(listener net.Listener) {
 // peers to and from the server, banning peers, and broadcasting messages to
 // peers.  It must be run a a goroutine.
 func (s *server) peerHandler() {
+	// Start the address manager and block manager, both of which are needed
+	// by peers.  This is done here since their lifecycle is closely tied
+	// to this handler and rather than adding more channels to sychronize
+	// things, it's easier and slightly faster to simply start and stop them
+	// in this handler.
+	s.addrManager.Start()
+	s.blockManager.Start()
+
 	log.Tracef("[SRVR] Starting peer handler")
 	peers := list.New()
 	bannedPeers := make(map[string]time.Time)
@@ -191,7 +199,6 @@ func (s *server) peerHandler() {
 	// Live while we're not shutting down or there are still connected peers.
 	for !s.shutdown || peers.Len() != 0 {
 		select {
-
 		// New peers connected to the server.
 		case p := <-s.newPeers:
 			s.handleAddPeerMsg(peers, bannedPeers, p)
@@ -218,6 +225,9 @@ func (s *server) peerHandler() {
 			}
 		}
 	}
+
+	s.blockManager.Stop()
+	s.addrManager.Stop()
 	s.wg.Done()
 	log.Tracef("[SRVR] Peer handler done")
 }
@@ -295,14 +305,20 @@ func (s *server) Start() {
 	}
 
 	log.Trace("[SRVR] Starting server")
+
+	// Start all the listeners.  There will not be any if listening is
+	// disabled.
 	for _, listener := range s.listeners {
 		go s.listenHandler(listener)
 		s.wg.Add(1)
 	}
+
+	// Start the peer handler which in turn starts the address and block
+	// managers.
 	go s.peerHandler()
 	s.wg.Add(1)
-	s.addrManager.Start()
-	s.blockManager.Start()
+
+	// Start the RPC server if it's not disabled.
 	if !cfg.DisableRpc {
 		s.rpcServer.Start()
 	}
@@ -319,19 +335,24 @@ func (s *server) Stop() error {
 	}
 
 	log.Warnf("[SRVR] Server shutting down")
+
+	// Set the shutdown flag and stop all the listeners.  There will not be
+	// any listeners if listening is disabled.
 	s.shutdown = true
-	close(s.quit)
-	if !cfg.DisableRpc {
-		s.rpcServer.Stop()
-	}
-	s.addrManager.Stop()
-	s.blockManager.Stop()
 	for _, listener := range s.listeners {
 		err := listener.Close()
 		if err != nil {
 			return err
 		}
 	}
+
+	// Shutdown the RPC server if it's not disabled.
+	if !cfg.DisableRpc {
+		s.rpcServer.Stop()
+	}
+
+	// Signal the remaining goroutines to quit.
+	close(s.quit)
 	return nil
 }