ogb912/opensim
1
0
Fork 0
mirror of https://github.com/opensim/opensim.git synced 2026-08-05 17:05:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

ScriptServer communication protocol (v1), primitive RPC-like TCP client/server

Browse Source
This commit is contained in:
Tedd Hansen
2008-01-12 00:48:58 +00:00
parent ef674acc24
commit 1e9a66cbaa
9 changed files with 491 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
OpenSim/Region/ScriptEngine/Common/TRPC/TCPClient.cs Normal file
View File

@@ -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);
}
}
}

33
OpenSim/Region/ScriptEngine/Common/TRPC/TCPCommon.cs Normal file
View File

@@ -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();
}
}
}

106
OpenSim/Region/ScriptEngine/Common/TRPC/TCPServer.cs Normal file
View File

@@ -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);
}
}
}

86
OpenSim/Region/ScriptEngine/Common/TRPC/TCPSocket.cs Normal file
View File

@@ -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);
}
}
}