aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/ICommandConsole.cs
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2011-10-25 20:24:21 +0100
committerJustin Clark-Casey (justincc)2011-10-25 20:24:21 +0100
commit8a0a78cbccce796addacab7ed1609279b802a9b3 (patch)
tree31ddb6da7bca6eeb61cb7747532dcf77828cfbe3 /OpenSim/Framework/ICommandConsole.cs
parentDrop some unnecessary ContainsKey() checking before Remove() in BaseHttpServer() (diff)
downloadopensim-SC-8a0a78cbccce796addacab7ed1609279b802a9b3.zip
opensim-SC-8a0a78cbccce796addacab7ed1609279b802a9b3.tar.gz
opensim-SC-8a0a78cbccce796addacab7ed1609279b802a9b3.tar.bz2
opensim-SC-8a0a78cbccce796addacab7ed1609279b802a9b3.tar.xz
Make OpenSim.Framework.Servers.HttpServer rely on OpenSim.Framework instead of the other way around.
This is necessary so that code in HttpServer can use framework facilities such as the thread watchdog for monitoring purposes. Doing this shuffle meant that MainServer was moved into OpenSim/Framework/Servers Also had to make OpenSim.Framework.Console rely on OpenSim.Framework rather than the other way around since it in turn relies on HttpServer MainConsole and some new interfaces had to be moved into OpenSim/Framework to allow this. This can be reverted if parts of OpenSim.Framework stop relying on console presence (cheifly RegionInfo)
Diffstat (limited to 'OpenSim/Framework/ICommandConsole.cs')
-rw-r--r--OpenSim/Framework/ICommandConsole.cs90
1 files changed, 90 insertions, 0 deletions
diff --git a/OpenSim/Framework/ICommandConsole.cs b/OpenSim/Framework/ICommandConsole.cs
new file mode 100644
index 0000000..d33b9b5
--- /dev/null
+++ b/OpenSim/Framework/ICommandConsole.cs
@@ -0,0 +1,90 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSimulator Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Collections.Generic;
30using System.Xml;
31
32namespace OpenSim.Framework
33{
34 public delegate void CommandDelegate(string module, string[] cmd);
35
36 public interface ICommands
37 {
38 void FromXml(XmlElement root, CommandDelegate fn);
39
40 /// <summary>
41 /// Get help for the given help string
42 /// </summary>
43 /// <param name="helpParts">Parsed parts of the help string. If empty then general help is returned.</param>
44 /// <returns></returns>
45 List<string> GetHelp(string[] cmd);
46
47 /// <summary>
48 /// Add a command to those which can be invoked from the console.
49 /// </summary>
50 /// <param name="module"></param>
51 /// <param name="command"></param>
52 /// <param name="help"></param>
53 /// <param name="longhelp"></param>
54 /// <param name="fn"></param>
55 void AddCommand(string module, bool shared, string command, string help, string longhelp, CommandDelegate fn);
56
57 /// <summary>
58 /// Add a command to those which can be invoked from the console.
59 /// </summary>
60 /// <param name="module"></param>
61 /// <param name="command"></param>
62 /// <param name="help"></param>
63 /// <param name="longhelp"></param>
64 /// <param name="descriptivehelp"></param>
65 /// <param name="fn"></param>
66 void AddCommand(string module, bool shared, string command,
67 string help, string longhelp, string descriptivehelp,
68 CommandDelegate fn);
69
70 string[] FindNextOption(string[] cmd, bool term);
71
72 string[] Resolve(string[] cmd);
73
74 XmlElement GetXml(XmlDocument doc);
75 }
76
77 public interface ICommandConsole : IConsole
78 {
79 ICommands Commands { get; }
80
81 /// <summary>
82 /// Display a command prompt on the console and wait for user input
83 /// </summary>
84 void Prompt();
85
86 void RunCommand(string cmd);
87
88 string ReadLine(string p, bool isCommand, bool e);
89 }
90} \ No newline at end of file