From 20e403685345e0e85d2eb54557b61dddc0af885e Mon Sep 17 00:00:00 2001 From: Johan Berntsson Date: Fri, 20 Jun 2008 01:35:54 +0000 Subject: [PATCH] Implemented plugin support for ClientStack, with LindenUDP as the default plugin. This makes it easy for developers to experiment with alternative communication protocols --- OpenSim/Region/Application/OpenSimBase.cs | 8 ++ .../Region/ClientStack/ClientStackManager.cs | 81 +++++++++++++++++++ .../ClientStack/IClientNetworkServer.cs | 7 +- .../ClientStack/LindenUDP/LLClientView.cs | 2 +- .../ClientStack/LindenUDP/LLUDPServer.cs | 5 ++ .../ClientStack/RegionApplicationBase.cs | 10 ++- .../3Di/LoadBalancer/LoadBalancerPlugin.cs | 2 + prebuild.xml | 38 +++++++++ 8 files changed, 147 insertions(+), 6 deletions(-) create mode 100644 OpenSim/Region/ClientStack/ClientStackManager.cs diff --git a/OpenSim/Region/Application/OpenSimBase.cs b/OpenSim/Region/Application/OpenSimBase.cs index 6d74903395..572e98ffae 100644 --- a/OpenSim/Region/Application/OpenSimBase.cs +++ b/OpenSim/Region/Application/OpenSimBase.cs @@ -81,6 +81,7 @@ namespace OpenSim protected LocalLoginService m_loginService; protected string m_storageDll; + protected string m_clientstackDll; protected List m_clientServers = new List(); protected List m_regionData = new List(); @@ -214,6 +215,7 @@ namespace OpenSim config.Set("shutdown_console_commands_file", String.Empty); config.Set("script_engine", "OpenSim.Region.ScriptEngine.DotNetEngine.dll"); config.Set("asset_database", "sqlite"); + config.Set("clientstack_plugin", "OpenSim.Region.ClientStack.LindenUDP.dll"); } if (DefaultConfig.Configs["StandAlone"] == null) @@ -301,6 +303,7 @@ namespace OpenSim m_scriptEngine = startupConfig.GetString("script_engine", "OpenSim.Region.ScriptEngine.DotNetEngine.dll"); m_assetStorage = startupConfig.GetString("asset_database", "local"); + m_clientstackDll = startupConfig.GetString("clientstack_plugin", "OpenSim.Region.ClientStack.LindenUDP.dll"); } IConfig standaloneConfig = m_config.Configs["StandAlone"]; @@ -553,6 +556,11 @@ namespace OpenSim return new StorageManager(m_storageDll, connectionstring, m_storagePersistPrimInventories); } + protected override ClientStackManager CreateClientStackManager() + { + return new ClientStackManager(m_clientstackDll); + } + protected override Scene CreateScene(RegionInfo regionInfo, StorageManager storageManager, AgentCircuitManager circuitManager) { diff --git a/OpenSim/Region/ClientStack/ClientStackManager.cs b/OpenSim/Region/ClientStack/ClientStackManager.cs new file mode 100644 index 0000000000..b5cd06aea6 --- /dev/null +++ b/OpenSim/Region/ClientStack/ClientStackManager.cs @@ -0,0 +1,81 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +using System; +using System.Net; +using System.Reflection; +using log4net; +using OpenSim.Framework; +using OpenSim.Region.ClientStack; +using OpenSim.Framework.Communications; +using OpenSim.Framework.Communications.Cache; + +namespace OpenSim.Region.Environment +{ + public class ClientStackManager + { + private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); + + private Type plugin; + private Assembly pluginAssembly; + + public ClientStackManager(string dllName) { + m_log.Info("[CLIENTSTACK]: Attempting to load " + dllName); + + plugin=null; + pluginAssembly = Assembly.LoadFrom(dllName); + + foreach (Type pluginType in pluginAssembly.GetTypes()) + { + if (pluginType.IsPublic) + { + Type typeInterface = pluginType.GetInterface("IClientNetworkServer", true); + + if (typeInterface != null) + { + m_log.Info("[CLIENTSTACK]: Added IClientNetworkServer Interface"); + plugin = pluginType; + return; + } + } + } + } + + public IClientNetworkServer CreateServer(IPAddress _listenIP, ref uint port, int proxyPortOffset, bool allow_alternate_port, AssetCache assetCache, AgentCircuitManager authenticateClass) + { + if (plugin != null) + { + IClientNetworkServer server = + (IClientNetworkServer) Activator.CreateInstance(pluginAssembly.GetType(plugin.ToString())); + server.Initialise(_listenIP, ref port, proxyPortOffset, allow_alternate_port, assetCache, authenticateClass); + return server; + } + m_log.Error("[CLIENTSTACK] Couldn't initialize a new server"); + return null; + } + } +} diff --git a/OpenSim/Region/ClientStack/IClientNetworkServer.cs b/OpenSim/Region/ClientStack/IClientNetworkServer.cs index 10da599a25..1743fd65c8 100644 --- a/OpenSim/Region/ClientStack/IClientNetworkServer.cs +++ b/OpenSim/Region/ClientStack/IClientNetworkServer.cs @@ -25,14 +25,19 @@ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +using System.Net; using System.Net.Sockets; using OpenSim.Framework; using OpenSim.Region.Environment.Scenes; +using OpenSim.Framework.Communications; +using OpenSim.Framework.Communications.Cache; namespace OpenSim.Region.ClientStack { public interface IClientNetworkServer { + void Initialise(IPAddress _listenIP, ref uint port, int proxyPortOffset, bool allow_alternate_port, AssetCache assetCache, AgentCircuitManager authenticateClass); + Socket Server { get; } bool HandlesRegion(Location x); void AddScene(Scene x); @@ -40,4 +45,4 @@ namespace OpenSim.Region.ClientStack void Start(); void Stop(); } -} \ No newline at end of file +} diff --git a/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs b/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs index 3dddbfb6e2..3b3ec3d358 100644 --- a/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs +++ b/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs @@ -72,7 +72,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP // } /* static variables */ - public static TerrainManager TerrainManager; + public static TerrainManager TerrainManager = new TerrainManager(new SecondLife()); public delegate bool SynchronizeClientHandler(IScene scene, Packet packet, LLUUID agentID, ThrottleOutPacketType throttlePacketType); public static SynchronizeClientHandler SynchronizeClient = null; diff --git a/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs b/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs index 4a56048cb9..eb4b8e7571 100644 --- a/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs +++ b/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs @@ -120,6 +120,11 @@ namespace OpenSim.Region.ClientStack.LindenUDP } public LLUDPServer(IPAddress _listenIP, ref uint port, int proxyPortOffset, bool allow_alternate_port, AssetCache assetCache, AgentCircuitManager authenticateClass) + { + Initialise(_listenIP, ref port, proxyPortOffset, allow_alternate_port, assetCache, authenticateClass); + } + + public void Initialise(IPAddress _listenIP, ref uint port, int proxyPortOffset, bool allow_alternate_port, AssetCache assetCache, AgentCircuitManager authenticateClass) { this.proxyPortOffset = proxyPortOffset; listenPort = (uint) (port + proxyPortOffset); diff --git a/OpenSim/Region/ClientStack/RegionApplicationBase.cs b/OpenSim/Region/ClientStack/RegionApplicationBase.cs index d96336af41..621d0efb06 100644 --- a/OpenSim/Region/ClientStack/RegionApplicationBase.cs +++ b/OpenSim/Region/ClientStack/RegionApplicationBase.cs @@ -35,7 +35,6 @@ using OpenSim.Framework; using OpenSim.Framework.Communications; using OpenSim.Framework.Communications.Cache; using OpenSim.Framework.Servers; -using OpenSim.Region.ClientStack.LindenUDP; using OpenSim.Region.Environment; using OpenSim.Region.Environment.Scenes; using OpenSim.Region.Physics.Manager; @@ -64,6 +63,8 @@ namespace OpenSim.Region.ClientStack protected StorageManager m_storageManager; protected string m_storageConnectionString; + protected ClientStackManager m_clientStackManager; + // An attribute to indicate whether prim inventories should be persisted. // Probably will be temporary until this stops being experimental. protected bool m_storagePersistPrimInventories; @@ -77,10 +78,10 @@ namespace OpenSim.Region.ClientStack { base.Startup(); - LLClientView.TerrainManager = new TerrainManager(new SecondLife()); - m_storageManager = CreateStorageManager(m_storageConnectionString); + m_clientStackManager = CreateClientStackManager(); + Initialize(); m_httpServer = new BaseHttpServer(m_httpServerPort); @@ -101,6 +102,7 @@ namespace OpenSim.Region.ClientStack // protected abstract ConsoleBase CreateConsole(); protected abstract PhysicsScene GetPhysicsScene(); protected abstract StorageManager CreateStorageManager(string connectionstring); + protected abstract ClientStackManager CreateClientStackManager(); protected PhysicsScene GetPhysicsScene(string engine, string meshEngine, IConfigSource config) { @@ -123,7 +125,7 @@ namespace OpenSim.Region.ClientStack // listenIP = IPAddress.Parse("0.0.0.0"); uint port = (uint) regionInfo.InternalEndPoint.Port; - clientServer = new LLUDPServer(listenIP, ref port, proxyOffset, regionInfo.m_allow_alternate_ports, m_assetCache, circuitManager); + clientServer = m_clientStackManager.CreateServer(listenIP, ref port, proxyOffset, regionInfo.m_allow_alternate_ports, m_assetCache, circuitManager); regionInfo.InternalEndPoint.Port = (int)port; Scene scene = CreateScene(regionInfo, m_storageManager, circuitManager); diff --git a/ThirdParty/3Di/LoadBalancer/LoadBalancerPlugin.cs b/ThirdParty/3Di/LoadBalancer/LoadBalancerPlugin.cs index 9a6c05bf32..69b8feaede 100644 --- a/ThirdParty/3Di/LoadBalancer/LoadBalancerPlugin.cs +++ b/ThirdParty/3Di/LoadBalancer/LoadBalancerPlugin.cs @@ -43,6 +43,8 @@ using OpenSim.Region.ClientStack; using OpenSim.Region.ClientStack.LindenUDP; using OpenSim.Region.Environment.Scenes; +// TODO: remove LindenUDP dependency + [assembly : Addin] [assembly : AddinDependency("OpenSim", "0.5")] [assembly : AddinDependency("RegionProxy", "0.1")] diff --git a/prebuild.xml b/prebuild.xml index 7413b1b1ef..1b24fa7495 100644 --- a/prebuild.xml +++ b/prebuild.xml @@ -818,6 +818,43 @@ + + + + + + + + + + ../../../../bin/ + + + + + ../../../../bin/ + + + + ../../../../bin/ + + + + + + + + + + + + + + + + + + @@ -1900,6 +1937,7 @@ +