RemoteAdmin:RemoteAdmin Implement new command/de
From OpenSimulator
This article or section is a Proposal It does not represent the current state of OpenSim, but is an idea for future work in OpenSim. Please feel free to update this page as part of the proposal discussion. |
This article or section contains incomplete information. Please help us by completing the content on this page. |
So implementieren Sie neue Befehle an Remote Admin
Bei der Implementierung eines neuen RemoteAdmin-Befehls müssen Sie die Datei /OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs bearbeiten
Bitte beachten Sie die RemoteAdmin Standards für das vorgeschlagene Namensschema.
Nehmen wir an, wir wollen einen Befehl erstellen, der eine Zeile in der Konsole ausgibt, die eine Nachricht und die Region uuid einer Region enthält, die wir wählen.
Schritt 1 - Hinzufügen eines neuen Befehls
Zuerst müssen wir unseren neuen Befehl definieren und zur Verfügung stellen. In der Funktion public void Initialise(OpenSimBase openSim) inden Sie eine Liste aller implementierten Befehle. Die verfügbaren Befehle beginnen mit availableMethods.... Dort fügen wir unseren neuen Befehl hinzu, nennen wir admin_output_message.
Wir werden nun eine neue availableMethods zu den bereits aufgeführten hinzufügen, waren admin_output_message ist unser Befehl und XmlRpcOutputMessage ist die Funktion, in der unser Befehl die Arbeit wehn aufgerufen hat (Schritt 2).
public void Initialise(OpenSimBase openSim) { ... //Unser neuer Befehl availableMethods["admin_output_message"] = (req, ep) => InvokeXmlRpcMethod(req, ep, XmlRpcOutputMessage); ... }
Schritt 2 - Codierung unseres neuen Kommandos
In Schritt 1 haben wir einen neuen Befehl hinzugefügt, der die Funktion XmlRpcOutputMessage. aufruft . So ist unser nächster Schritt, unsere neue Funktion zu schaffen und alle goddies, die unser Befehl ausführen wird, zu umfassen.
private void XmlRpcOutputMessage(XmlRpcRequest request, XmlRpcResponse response, IPEndPoint remoteClient) { //Liste mit allen Parametern, die zurückgegeben werden Hashtable responseData = (Hashtable)response.Value; //Liste mit allen empfangenen Parametern Hashtable requestData = (Hashtable)request.Params[0]; //Prüfen Sie, ob die Parametermeldung empfangen wurde CheckStringParameters(requestData, responseData, new string[] { "message" }); Scene scene = null; string error_message = String.Empty; responseData["success"] = false; //Prüfen Sie, ob eine Region mit dem Parameter region_id oder region_name existiert CheckRegionParamsInScene(requestData, out scene, out error_message); if (scene == null) { //Die Region ist nicht bekannt, also senden wir eine Fehlermeldung responseData["error"] = error_message; throw new Exception(error_message); } // Hier arbeiten wir alle, wenn eine Region gefunden wird string message = (string) requestData["message"]; m_log.InfoFormat("[RADMIN]: {0}: {1} {2}", message, scene.RegionInfo.RegionName, scene.RegionInfo.RegionID); // Wir haben unsere Arbeit beendet, lasst uns einige Informationen zurückschicken responseData["success"] = true; responseData["region_name"] = scene.RegionInfo.RegionName; }
- Unsere neue Funktion beginnt immer mit der Erstellung der Hashtable responseData und requestData. In the requestData Liste haben wir alle Parameter, die wir von unserer externen Anwendung erhalten, während responseData Liste der Daten ist, die wir zurückschicken ...
- Wenn wir Parameter haben, die benötigt werden und möglicherweise nicht leer sind, dann überprüft man diese Parameter mit CheckStringParameters und CheckIntegerParams. Wenn einer der angegebenen Paramater, in unserem Fall die Zeichenfolge "message" nicht gegeben ist, dann wird ein Fehler mit Ausnahme gegeben und der Rest unseres Codes wird nicht ausgeführt.
- Da wir regionale Daten einer bestimmten region_id oder region_name senden wollen, verwenden wir CheckRegionParamsInScene. Dies wird uns die scene der Region ausgeben, wenn sie existiert. Sowohl region_id und region_name werden geprüft. Wenn keine Region gefunden wird, dann ist scene = null und eine error_mesage wird zurückgegeben. Die Fehlermeldung kann verwendet werden, um als Antwort zurückzugegeben responseData["error"]
- Als Antwort geben wir immer responseData["success"] als true oder false werden zurückgegeben, wenn keine Fehler aufgetreten sind.
- Wenn Fehler auftreten, senden wir die Fehlermeldung an unsere Anwendung als responseData["error"]