Make merge map a member variable

Author: Linas Beresna

include/IECoreImage/DisplayDriverServer.h

@@ -99,12 +99,7 @@ class IECOREIMAGE_API DisplayDriverServer : public IECore::RunTimeTyped
 		static void deregisterPortRange( const std::string &name );
 		static const PortRange &registeredPortRange( const std::string &name );
 
-		// Get the number of merge drivers associated with
-		// the current merge id.
-		static const MergeDriverInfo &getMergeDriverInfo( int mergeId );
-
 	private:
-
 		// Session class
 		// Takes care of one client connection.
 		class Session;
@@ -116,6 +111,8 @@ class IECOREIMAGE_API DisplayDriverServer : public IECore::RunTimeTyped
 		class PrivateData;
 		IE_CORE_DECLAREPTR( PrivateData );
 		PrivateDataPtr m_data;
+
+		MergeMap m_mergeMap;
 };
 
 IE_CORE_DECLAREPTR( DisplayDriverServer )

src/IECoreImage/DisplayDriverServer.cpp

@@ -73,8 +73,6 @@ IE_CORE_DEFINERUNTIMETYPED( DisplayDriverServer );
 namespace
 {
 
-DisplayDriverServer::MergeMap g_mergeMap;
-
 /* Set the FD_CLOEXEC flag for the given socket descriptor, so that it will not exist on child processes.*/
 static void fixSocketFlags( int socketDesc )
 {
@@ -100,7 +98,7 @@ class DisplayDriverServer::Session : public RefCounted
 {
 	public:
 
-		Session( boost::asio::io_service& io_service );
+		Session( boost::asio::io_service& io_service, DisplayDriverServer::MergeMap& mergeMap );
 		~Session() override;
 
 		boost::asio::ip::tcp::socket& socket();
@@ -119,7 +117,8 @@ class DisplayDriverServer::Session : public RefCounted
 		DisplayDriverPtr m_displayDriver;
 		DisplayDriverServerHeader m_header;
 		CharVectorDataPtr m_buffer;
-        std::optional<int> m_mergeId;
+		DisplayDriverServer::MergeMap& m_mergeMap;
+		std::optional<int> m_mergeId;
 };
 
 class DisplayDriverServer::PrivateData : public RefCounted
@@ -202,7 +201,7 @@ DisplayDriverServer::DisplayDriverServer( DisplayDriverServer::Port portNumber )
 {
 	m_data = new DisplayDriverServer::PrivateData( portNumber );
 
-	DisplayDriverServer::SessionPtr newSession( new DisplayDriverServer::Session( m_data->m_service ) );
+	DisplayDriverServer::SessionPtr newSession( new DisplayDriverServer::Session( m_data->m_service, m_mergeMap ) );
 	m_data->m_acceptor.async_accept( newSession->socket(),
 			boost::bind( &DisplayDriverServer::handleAccept, this, newSession,
 			boost::asio::placeholders::error));
@@ -265,17 +264,6 @@ const DisplayDriverServer::PortRange &DisplayDriverServer::registeredPortRange(
 	return it->second;
 }
 
-const DisplayDriverServer::MergeDriverInfo &DisplayDriverServer::getMergeDriverInfo( int mergeId )
-{
-	auto it = g_mergeMap.find( mergeId );
-	if( it == g_mergeMap.end() )
-	{
-		throw IECore::InvalidArgumentException( "DisplayDriverServer::getMergeCount : " + std::to_string(mergeId) + " is not in the merge map." );
-	}
-
-	return it->second;
-}
-
 DisplayDriverServer::Port DisplayDriverServer::portNumber()
 {
 	return m_data->m_acceptor.local_endpoint().port();
@@ -297,7 +285,7 @@ void DisplayDriverServer::handleAccept( DisplayDriverServer::SessionPtr session,
 {
 	if (!error)
 	{
-		DisplayDriverServer::SessionPtr newSession( new DisplayDriverServer::Session( m_data->m_service ) );
+		DisplayDriverServer::SessionPtr newSession( new DisplayDriverServer::Session( m_data->m_service, m_mergeMap ) );
 		m_data->m_acceptor.async_accept( newSession->socket(),
 				boost::bind( &DisplayDriverServer::handleAccept,  this, newSession,
 				boost::asio::placeholders::error));
@@ -309,8 +297,8 @@ void DisplayDriverServer::handleAccept( DisplayDriverServer::SessionPtr session,
  * DisplayDriverServer::Session functions
  */
 
-DisplayDriverServer::Session::Session( boost::asio::io_service& io_service ) :
-	m_socket( io_service ), m_displayDriver(nullptr), m_buffer( new CharVectorData( ) )
+DisplayDriverServer::Session::Session( boost::asio::io_service& io_service, DisplayDriverServer::MergeMap& mergeMap ) :
+	m_socket( io_service ), m_displayDriver(nullptr), m_buffer( new CharVectorData( ) ), m_mergeMap( mergeMap )
 {
 }
 
@@ -386,10 +374,10 @@ void DisplayDriverServer::Session::handleReadHeader( const boost::system::error_
 				}
 				else
 				{
-					auto &m = g_mergeMap.at(m_mergeId.value()); // Error out if not found
+					auto &m = m_mergeMap.at(m_mergeId.value()); // Error out if not found
 					if ( --m.mergeCount <= 0 )
 					{
-						g_mergeMap.erase(m_mergeId.value());
+						m_mergeMap.erase(m_mergeId.value());
 						m_displayDriver->imageClose();
 					}
 				}
@@ -462,7 +450,7 @@ void DisplayDriverServer::Session::handleReadOpenParameters( const boost::system
 			m_mergeId = parameters->member<IntData>( "displayDriverServer:mergeId", false /* throw if missing */ )->readable();
 
 			// Check if merge ID in map, if not then create display driver and session count pair with merge ID.
-			auto &m = g_mergeMap[m_mergeId.value()];
+			auto &m = m_mergeMap[m_mergeId.value()];
 			if ( !m.mergeDriver )
 			{
 				const IntData *sessionClientsData = parameters->member<IntData>( "displayDriverServer:mergeClients", true /* throw if missing */ );

src/IECoreImageBindings/DisplayDriverServerBinding.cpp

@@ -72,12 +72,6 @@ boost::python::tuple registeredPortRange( const std::string &name )
 	return boost::python::make_tuple( range.first, range.second );
 }
 
-boost::python::tuple getMergeDriverInfo( int mergeId )
-{
-	auto mergeDriverInfo = DisplayDriverServer::getMergeDriverInfo( mergeId );
-	return boost::python::make_tuple( mergeDriverInfo.mergeDriver, mergeDriverInfo.mergeCount );
-}
-
 } // namespace
 
 namespace IECoreImageBindings
@@ -95,7 +89,6 @@ void bindDisplayDriverServer()
 		.def( "registerPortRange", &::registerPortRange ).staticmethod( "registerPortRange" )
 		.def( "deregisterPortRange", &DisplayDriverServer::deregisterPortRange ).staticmethod( "deregisterPortRange" )
 		.def( "registeredPortRange", &registeredPortRange ).staticmethod( "registeredPortRange" )
-		.def( "getMergeDriverInfo", &getMergeDriverInfo).staticmethod( "getMergeDriverInfo" )
 	;
 
 }

test/IECoreImage/DisplayDriverServerTest.py

@@ -161,23 +161,8 @@ def testMergeMap( self ) :
 			idd2.imageData( imath.Box2i( imath.V2i( img.dataWindow.min().x, i + img.dataWindow.min().y ), imath.V2i( img.dataWindow.max().x, i + img.dataWindow.min().y) ), buf )
 			idd3.imageData( imath.Box2i( imath.V2i( img.dataWindow.min().x, i + img.dataWindow.min().y ), imath.V2i( img.dataWindow.max().x, i + img.dataWindow.min().y) ), buf )
 
-		# Test that the merge map has merge id 42 and that there are two clients
-		mergeDriverInfo = IECoreImage.DisplayDriverServer.getMergeDriverInfo( 42 )
-		self.assertEqual( mergeDriverInfo[1], 2 )
-
-		# Test that a new merge driver with a new id creates a new display driver
-		mergeDriverInfo2 = IECoreImage.DisplayDriverServer.getMergeDriverInfo( 666 )
-		self.assertNotEqual( mergeDriverInfo[0], mergeDriverInfo2[0] )
-
-		# Test that one image close will remove one client from the merge map
 		idd1.imageClose()
-		mergeDriverInfo = IECoreImage.DisplayDriverServer.getMergeDriverInfo( 42 )
-		self.assertEqual( mergeDriverInfo[1], 1 )
-
-		# Test that after the last image close no clients are left in the map
 		idd2.imageClose()
-		self.assertRaises( RuntimeError, lambda : IECoreImage.DisplayDriverServer.getMergeDriverInfo( 42 ) )
-
 		idd3.imageClose()
 
 		newImg = IECoreImage.ImageDisplayDriver.removeStoredImage( "myHandle1" )