ScriptServer communication protocol (v1), primitive RPC-like TCP client/server
Tedd Hansen
parent
ef674acc24
commit
1e9a66cbaa
|
|
@ -40,7 +40,7 @@ namespace OpenSim.Grid.ScriptServer
|
|||
// Root object. Creates objects used.
|
||||
//
|
||||
private int listenPort = 1234;
|
||||
private readonly string m_logFilename = ("region-console.log");
|
||||
private readonly string m_logFilename = ("scriptserver.log");
|
||||
private LogBase m_log;
|
||||
|
||||
// TEMP
|
||||
|
|
|
|||
|
|
@ -0,0 +1,109 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Net;
|
||||
using System.Net.Sockets;
|
||||
using System.Text;
|
||||
|
||||
namespace OpenSim.Region.ScriptEngine.Common.TRPC
|
||||
{
|
||||
public class TCPClient: TCPCommon.ClientInterface
|
||||
{
|
||||
|
||||
public TCPClient()
|
||||
{
|
||||
}
|
||||
private readonly Dictionary<int, TCPSocket> Clients = new Dictionary<int, TCPSocket>();
|
||||
private int ClientCount = 0;
|
||||
|
||||
|
||||
public event TCPCommon.ClientConnectedDelegate ClientConnected;
|
||||
public event TCPCommon.DataReceivedDelegate DataReceived;
|
||||
public event TCPCommon.DataSentDelegate DataSent;
|
||||
public event TCPCommon.CloseDelegate Close;
|
||||
public event TCPCommon.ConnectErrorDelegate ConnectError;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Creates client connection
|
||||
/// </summary>
|
||||
public void Connect(string RemoteHost, int RemotePort)
|
||||
{
|
||||
Socket newsock = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
|
||||
IPEndPoint ipe = new IPEndPoint(IPAddress.Parse(RemoteHost), RemotePort);
|
||||
newsock.BeginConnect(ipe, new AsyncCallback(asyncConnected), newsock);
|
||||
|
||||
|
||||
}
|
||||
|
||||
public void Disconnect(int ID)
|
||||
{
|
||||
Clients[ID].Disconnect();
|
||||
}
|
||||
|
||||
void asyncConnected(IAsyncResult iar)
|
||||
{
|
||||
Socket client = (Socket)iar.AsyncState;
|
||||
try
|
||||
{
|
||||
client.EndConnect(iar);
|
||||
|
||||
|
||||
int id = ClientCount++;
|
||||
TCPSocket S = new TCPSocket(id, client);
|
||||
|
||||
// Add to dictionary
|
||||
Clients.Add(id, S);
|
||||
|
||||
// Add event handlers
|
||||
S.Close += new TCPSocket.CloseDelegate(S_Close);
|
||||
S.DataReceived += new TCPSocket.DataReceivedDelegate(S_DataReceived);
|
||||
S.DataSent += new TCPSocket.DataSentDelegate(S_DataSent);
|
||||
|
||||
// Start it
|
||||
S.Start();
|
||||
|
||||
Debug.WriteLine("Connection established: " + client.RemoteEndPoint.ToString());
|
||||
|
||||
// Fire Connected-event
|
||||
if (ClientConnected != null)
|
||||
ClientConnected(id, client.RemoteEndPoint);
|
||||
|
||||
}
|
||||
catch (SocketException sex)
|
||||
{
|
||||
if (ConnectError != null)
|
||||
ConnectError(sex.Message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
void S_DataSent(int ID, int length)
|
||||
{
|
||||
if (DataSent != null)
|
||||
DataSent(ID, length);
|
||||
}
|
||||
|
||||
void S_DataReceived(int ID, byte[] data, int offset, int length)
|
||||
{
|
||||
if (DataReceived != null)
|
||||
DataReceived(ID, data, offset, length);
|
||||
}
|
||||
|
||||
void S_Close(int ID)
|
||||
{
|
||||
if (Close != null)
|
||||
Close(ID);
|
||||
Clients.Remove(ID);
|
||||
}
|
||||
|
||||
public void Send(int clientID, byte[] data, int offset, int len)
|
||||
{
|
||||
Clients[clientID].Send(clientID, data, offset, len);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
namespace OpenSim.Region.ScriptEngine.Common.TRPC
|
||||
{
|
||||
public class TCPCommon
|
||||
{
|
||||
public delegate void ClientConnectedDelegate(int ID, System.Net.EndPoint Remote);
|
||||
public delegate void DataReceivedDelegate(int ID, byte[] data, int offset, int length);
|
||||
public delegate void DataSentDelegate(int ID, int length);
|
||||
public delegate void CloseDelegate(int ID);
|
||||
public delegate void ConnectErrorDelegate(string Reason);
|
||||
|
||||
|
||||
public interface ServerAndClientInterface
|
||||
{
|
||||
void Send(int clientID, byte[] data, int offset, int len);
|
||||
event ClientConnectedDelegate ClientConnected;
|
||||
event DataReceivedDelegate DataReceived;
|
||||
event DataSentDelegate DataSent;
|
||||
event CloseDelegate Close;
|
||||
}
|
||||
public interface ClientInterface : ServerAndClientInterface
|
||||
{
|
||||
event TCPCommon.ConnectErrorDelegate ConnectError;
|
||||
void Connect(string RemoteHost, int RemotePort);
|
||||
void Disconnect(int ID);
|
||||
}
|
||||
public interface ServerInterface : ServerAndClientInterface
|
||||
{
|
||||
void StartListen();
|
||||
void StopListen();
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Net;
|
||||
using System.Net.Sockets;
|
||||
using TCPCommon=OpenSim.Region.ScriptEngine.Common.TRPC.TCPCommon;
|
||||
|
||||
namespace OpenSim.Region.ScriptEngine.Common.TRPC
|
||||
{
|
||||
public class TCPServer: TCPCommon.ServerInterface
|
||||
{
|
||||
public readonly int LocalPort;
|
||||
public TCPServer(int localPort)
|
||||
{
|
||||
LocalPort = localPort;
|
||||
}
|
||||
|
||||
private Socket server;
|
||||
|
||||
/// <summary>
|
||||
/// Starts listening for new connections
|
||||
/// </summary>
|
||||
public void StartListen()
|
||||
{
|
||||
server = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
|
||||
IPEndPoint ipe = new IPEndPoint(IPAddress.Any, LocalPort);
|
||||
server.Bind(ipe);
|
||||
server.Listen(10);
|
||||
server.BeginAccept(new AsyncCallback(AsyncAcceptConnections), server);
|
||||
}
|
||||
/// <summary>
|
||||
/// Stops listening for new connections
|
||||
/// </summary>
|
||||
public void StopListen()
|
||||
{
|
||||
server.Close();
|
||||
server = null;
|
||||
}
|
||||
|
||||
private readonly Dictionary<int, TCPSocket> Clients = new Dictionary<int, TCPSocket>();
|
||||
private int ClientCount = 0;
|
||||
|
||||
|
||||
public event TCPCommon.ClientConnectedDelegate ClientConnected;
|
||||
public event TCPCommon.DataReceivedDelegate DataReceived;
|
||||
public event TCPCommon.DataSentDelegate DataSent;
|
||||
public event TCPCommon.CloseDelegate Close;
|
||||
|
||||
/// <summary>
|
||||
/// Async callback for new connections
|
||||
/// </summary>
|
||||
/// <param name="ar"></param>
|
||||
private void AsyncAcceptConnections(IAsyncResult ar)
|
||||
{
|
||||
int id = ClientCount++;
|
||||
Socket oldserver = (Socket)ar.AsyncState;
|
||||
Socket client = oldserver.EndAccept(ar);
|
||||
TCPSocket S = new TCPSocket(id, client);
|
||||
|
||||
// Add to dictionary
|
||||
Clients.Add(id, S);
|
||||
|
||||
// Add event handlers
|
||||
S.Close += new TCPSocket.CloseDelegate(S_Close);
|
||||
S.DataReceived += new TCPSocket.DataReceivedDelegate(S_DataReceived);
|
||||
S.DataSent += new TCPSocket.DataSentDelegate(S_DataSent);
|
||||
|
||||
// Start it
|
||||
S.Start();
|
||||
|
||||
Debug.WriteLine("Connection received: " + client.RemoteEndPoint.ToString());
|
||||
|
||||
// Fire Connected-event
|
||||
if (ClientConnected != null)
|
||||
ClientConnected(id, client.RemoteEndPoint);
|
||||
|
||||
}
|
||||
|
||||
void S_DataSent(int ID, int length)
|
||||
{
|
||||
if (DataSent != null)
|
||||
DataSent(ID, length);
|
||||
}
|
||||
|
||||
void S_DataReceived(int ID, byte[] data, int offset, int length)
|
||||
{
|
||||
if (DataReceived != null)
|
||||
DataReceived(ID, data, offset, length);
|
||||
}
|
||||
|
||||
void S_Close(int ID)
|
||||
{
|
||||
if (Close != null)
|
||||
Close(ID);
|
||||
Clients.Remove(ID);
|
||||
}
|
||||
|
||||
public void Send(int clientID, byte[] data, int offset, int len)
|
||||
{
|
||||
Clients[clientID].Send(clientID, data, offset, len);
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
using System;
|
||||
using System.Net.Sockets;
|
||||
|
||||
namespace OpenSim.Region.ScriptEngine.Common.TRPC
|
||||
{
|
||||
public class TCPSocket
|
||||
{
|
||||
|
||||
public readonly Socket Client;
|
||||
public readonly int ID;
|
||||
|
||||
public delegate void DataReceivedDelegate(int ID, byte[] data, int offset, int length);
|
||||
public delegate void DataSentDelegate(int ID, int length);
|
||||
public delegate void CloseDelegate(int ID);
|
||||
public event DataReceivedDelegate DataReceived;
|
||||
public event DataSentDelegate DataSent;
|
||||
public event CloseDelegate Close;
|
||||
|
||||
private byte[] RecvQueue = new byte[4096];
|
||||
private int RecvQueueSize = 4096;
|
||||
|
||||
public TCPSocket(int id, Socket client)
|
||||
{
|
||||
ID = id;
|
||||
Client = client;
|
||||
}
|
||||
public void Start()
|
||||
{
|
||||
// Start listening
|
||||
BeginReceive();
|
||||
}
|
||||
|
||||
private void BeginReceive()
|
||||
{
|
||||
Client.BeginReceive(RecvQueue, 0, RecvQueueSize, SocketFlags.None, new AsyncCallback(asyncDataReceived), Client);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Callback for successful receive (or connection close)
|
||||
/// </summary>
|
||||
/// <param name="ar"></param>
|
||||
private void asyncDataReceived(IAsyncResult ar)
|
||||
{
|
||||
Socket client = (Socket)ar.AsyncState;
|
||||
int recv = client.EndReceive(ar);
|
||||
|
||||
// Is connection closed?
|
||||
if (recv == 0)
|
||||
{
|
||||
client.Close();
|
||||
Close(ID);
|
||||
return;
|
||||
}
|
||||
|
||||
// Call receive event
|
||||
DataReceived(ID, RecvQueue, 0, recv);
|
||||
|
||||
// Start new receive
|
||||
BeginReceive();
|
||||
|
||||
}
|
||||
|
||||
|
||||
public void Send(int clientID, byte[] data, int offset, int len)
|
||||
{
|
||||
Client.BeginSend(data, offset, len, SocketFlags.None, new AsyncCallback(asyncDataSent), Client);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Callback for successful send
|
||||
/// </summary>
|
||||
/// <param name="ar"></param>
|
||||
void asyncDataSent(IAsyncResult ar)
|
||||
{
|
||||
Socket client = (Socket)ar.AsyncState;
|
||||
int sent = client.EndSend(ar);
|
||||
DataSent(ID, sent);
|
||||
}
|
||||
|
||||
public void Disconnect()
|
||||
{
|
||||
Client.Close();
|
||||
Close(ID);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,144 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Text;
|
||||
using OpenSim.Region.ScriptEngine.Common.TRPC;
|
||||
|
||||
namespace OpenSim.Region.ScriptEngine.Common
|
||||
{
|
||||
public class TRPC_Remote
|
||||
{
|
||||
public readonly int MaxQueueSize = 1024 * 10;
|
||||
public readonly TCPCommon.ServerAndClientInterface TCPS;
|
||||
|
||||
public delegate void ReceiveCommandDelegate(int ID, string Command, params object[] p);
|
||||
public event ReceiveCommandDelegate ReceiveCommand;
|
||||
|
||||
// TODO: Maybe we should move queue into TCPSocket so we won't have to keep one queue instance per connection
|
||||
private System.Collections.Generic.Dictionary<int, InQueueStruct> InQueue = new Dictionary<int, InQueueStruct>();
|
||||
private class InQueueStruct
|
||||
{
|
||||
public byte[] Queue;
|
||||
public int QueueSize;
|
||||
public object QueueLockObject = new object();
|
||||
}
|
||||
|
||||
public TRPC_Remote(TCPCommon.ServerAndClientInterface TCPClientOrServer)
|
||||
{
|
||||
TCPS = TCPClientOrServer;
|
||||
TCPS.Close += new TCPCommon.CloseDelegate(TCPS_Close);
|
||||
TCPS.ClientConnected += new TCPCommon.ClientConnectedDelegate(TCPS_ClientConnected);
|
||||
TCPS.DataReceived += new TCPCommon.DataReceivedDelegate(TCPS_DataReceived);
|
||||
//TCPS.StartListen();
|
||||
}
|
||||
|
||||
void TCPS_ClientConnected(int ID, System.Net.EndPoint Remote)
|
||||
{
|
||||
// Create a incoming queue for this connection
|
||||
InQueueStruct iq = new InQueueStruct();
|
||||
iq.Queue = new byte[MaxQueueSize];
|
||||
iq.QueueSize = 0;
|
||||
InQueue.Add(ID, iq);
|
||||
}
|
||||
|
||||
void TCPS_Close(int ID)
|
||||
{
|
||||
// Remove queue
|
||||
InQueue.Remove(ID);
|
||||
}
|
||||
|
||||
void TCPS_DataReceived(int ID, byte[] data, int offset, int length)
|
||||
{
|
||||
// Copy new data to incoming queue
|
||||
lock (InQueue[ID].QueueLockObject)
|
||||
{
|
||||
Array.Copy(data, offset, InQueue[ID].Queue, InQueue[ID].QueueSize, length);
|
||||
InQueue[ID].QueueSize += length;
|
||||
|
||||
// Process incoming queue
|
||||
ProcessQueue(ID);
|
||||
}
|
||||
}
|
||||
|
||||
private void ProcessQueue(int ID)
|
||||
{
|
||||
|
||||
// This is just a temp implementation -- not so fast :)
|
||||
|
||||
InQueueStruct myIQS = InQueue[ID];
|
||||
if (myIQS.QueueSize == 0)
|
||||
return;
|
||||
|
||||
string receivedData = Encoding.ASCII.GetString(myIQS.Queue, 0, myIQS.QueueSize);
|
||||
Debug.WriteLine("RAW: " + receivedData);
|
||||
|
||||
|
||||
byte newLine = 10;
|
||||
while (true)
|
||||
{
|
||||
bool ShouldProcess = false;
|
||||
int lineEndPos = 0;
|
||||
|
||||
// Look for newline
|
||||
for (int i = 0; i < myIQS.QueueSize; i++)
|
||||
{
|
||||
if (myIQS.Queue[i] == newLine)
|
||||
{
|
||||
ShouldProcess = true;
|
||||
lineEndPos = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Process it?
|
||||
if (!ShouldProcess)
|
||||
return;
|
||||
// Yes
|
||||
string cmdLine = Encoding.ASCII.GetString(myIQS.Queue, 0, lineEndPos);
|
||||
Debug.WriteLine("Command: " + cmdLine);
|
||||
|
||||
// Fix remaining queue in an inefficient way
|
||||
byte[] newQueue = new byte[MaxQueueSize];
|
||||
Array.Copy(myIQS.Queue, lineEndPos, newQueue, 0, myIQS.QueueSize - lineEndPos);
|
||||
myIQS.Queue = newQueue;
|
||||
myIQS.QueueSize -= (lineEndPos + 1);
|
||||
|
||||
// Now back to the command
|
||||
string[] parts = cmdLine.Split(',');
|
||||
if (parts.Length > 0)
|
||||
{
|
||||
string cmd = parts[0];
|
||||
int paramCount = parts.Length - 1;
|
||||
string[] param = null;
|
||||
|
||||
if (paramCount > 0)
|
||||
{
|
||||
// Process all parameters (decoding them from URL encoding)
|
||||
param = new string[paramCount];
|
||||
for (int i = 1; i < parts.Length; i++)
|
||||
{
|
||||
param[i - 1] = System.Web.HttpUtility.UrlDecode(parts[i]);
|
||||
}
|
||||
}
|
||||
|
||||
ReceiveCommand(ID, cmd, param);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void SendCommand(int ID, string Command, params object[] p)
|
||||
{
|
||||
// Call PacketFactory to have it create a packet for us
|
||||
|
||||
//string[] tmpP = new string[p.Length];
|
||||
string tmpStr = Command;
|
||||
for (int i = 0; i < p.Length; i++)
|
||||
{
|
||||
tmpStr += "," + System.Web.HttpUtility.UrlEncode(p[i].ToString()); // .Replace(",", "%44")
|
||||
}
|
||||
tmpStr += "\n";
|
||||
byte[] byteData = Encoding.ASCII.GetBytes(tmpStr);
|
||||
TCPS.Send(ID, byteData, 0, byteData.Length);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -48,6 +48,7 @@ namespace OpenSim.Region.ScriptEngine.RemoteServer
|
|||
{
|
||||
myScriptEngine = _ScriptEngine;
|
||||
|
||||
|
||||
myScriptEngine.Log.Verbose("RemoteEngine", "Hooking up to server events");
|
||||
//myScriptEngine.World.EventManager.OnObjectGrab += touch_start;
|
||||
myScriptEngine.World.EventManager.OnRezScript += OnRezScript;
|
||||
|
|
@ -61,10 +62,11 @@ namespace OpenSim.Region.ScriptEngine.RemoteServer
|
|||
{
|
||||
// WE ARE CREATING A NEW SCRIPT ... CREATE SCRIPT, GET A REMOTEID THAT WE MAP FROM LOCALID
|
||||
myScriptEngine.Log.Verbose("RemoteEngine", "Creating new script (with connection)");
|
||||
|
||||
|
||||
ScriptServerInterfaces.ServerRemotingObject obj = myScriptEngine.m_RemoteServer.Connect("localhost", 1234);
|
||||
|
||||
remoteScript.Add(localID, obj);
|
||||
//remoteScript[localID].Events.OnRezScript(localID, itemID, script);
|
||||
remoteScript[localID].Events().OnRezScript(localID, itemID, script);
|
||||
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -13,19 +13,17 @@ namespace OpenSim.Region.ScriptEngine.RemoteServer
|
|||
// Handles connections to servers
|
||||
// Create and returns server object
|
||||
|
||||
public RemoteServer()
|
||||
{
|
||||
TcpChannel chan = new TcpChannel();
|
||||
ChannelServices.RegisterChannel(chan, true);
|
||||
}
|
||||
|
||||
public ScriptServerInterfaces.ServerRemotingObject Connect(string hostname, int port)
|
||||
{
|
||||
// Create a channel for communicating w/ the remote object
|
||||
// Notice no port is specified on the client
|
||||
TcpChannel chan = new TcpChannel();
|
||||
try
|
||||
{
|
||||
ChannelServices.RegisterChannel(chan, true);
|
||||
}
|
||||
catch (System.Runtime.Remoting.RemotingException)
|
||||
{
|
||||
System.Console.WriteLine("Error: tcp already registered, RemoteServer.cs in OpenSim.Region.ScriptEngine.RemoteServer line 24");
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
|
||||
|
|
|
|||
|
|
@ -1113,6 +1113,7 @@
|
|||
<ReferencePath>../../../../bin/ScriptEngines/</ReferencePath>
|
||||
<Reference name="System" localCopy="false"/>
|
||||
<Reference name="System.Data" localCopy="false"/>
|
||||
<Reference name="System.Web" localCopy="false"/>
|
||||
<Reference name="System.Xml" localCopy="false"/>
|
||||
<Reference name="libsecondlife.dll"/>
|
||||
<Reference name="OpenSim.Framework"/>
|
||||
|
|
|
|||
Loading…
Reference in New Issue