Commit: 9a76071abc774fa4353d49f89c276fe25491f5fb - SocketNet (git)

ソケットを使ってクライアントサーバプログラムを作成するための C# ライブラリ

Commit MetaInfo

• Revisão: 9a76071abc774fa4353d49f89c276fe25491f5fb (tree)
• Hora: 2015-08-14 23:30:40
• Autor: tsntsumi <tsntsumi@tsnt...>
• Commiter: tsntsumi

Mensagem de Log

TcpConnection と TcpServer の共通データを独立させる修正

TcpConnection 内部で使用する HeaderLength, FooterLength,
ObtainPayloadLength は、生成する際にオプションとして引数で指
定可能としている。TcpServer では、パケットの受信に
TcpConnection を生成して使用するため、同様のデータをオプショ
ン引数で指定しなければならなかった。そのため、デフォルトの値
を二重に管理しなければならなかった。

そこで、デフォルトの値を、新規に作成した Packet クラスのオブ
ジェクトで管理するように変更した。

Mudança Sumário

• modified: src/SocketNet/SampleChatClient/ChatClient.cs
• modified: src/SocketNet/SampleChatClient/ChatMessage.cs
• modified: src/SocketNet/SampleChatServer/ChatServer.cs
• add: src/SocketNet/SocketNet/Packet.cs
• modified: src/SocketNet/SocketNet/SocketNet.csproj
• modified: src/SocketNet/SocketNet/TcpConnection.cs
• modified: src/SocketNet/SocketNet/TcpServer.cs

Diff

--- a/src/SocketNet/SampleChatClient/ChatClient.cs
+++ b/src/SocketNet/SampleChatClient/ChatClient.cs
@@ -106,8 +106,7 @@ namespace SampleChatClient
 				RemoteIPAddress = serverIPAddress;
 				RemotePort = serverPort;
 				client.Connect(RemoteIPAddress, RemotePort);
-				Connection = new TcpConnection(client.Client,
-					ChatMessage.HeaderLength, ChatMessage.FooterLength, ChatMessage.ObtainPayloadLength);
+				Connection = new TcpConnection(client.Client, new ChatMessage());
 				Connection.DataReceived += OnDataReceived;
 			}
 		}

--- a/src/SocketNet/SampleChatClient/ChatMessage.cs
+++ b/src/SocketNet/SampleChatClient/ChatMessage.cs
@@ -8,10 +8,9 @@ namespace SampleChatClient
 	/// <summary>
 	/// <see cref="ChatServer"/>  と <see cref="ChatClient"/>  間で送受信されるチャットメッセージを表します。
 	/// </summary>
-	public class ChatMessage
+	public class ChatMessage: Packet
 	{
-		public const int HeaderLength = 2;
-		public const int FooterLength = 0;
+		public override int HeaderLength { get { return 2; } }
 
 		/// <summary>
 		/// メッセージを送受信する接続を取得または設定します。
@@ -26,6 +25,13 @@ namespace SampleChatClient
 		/// <summary>
 		/// コンストラクタ。
 		/// </summary>
+		public ChatMessage()
+		{
+		}
+
+		/// <summary>
+		/// コンストラクタ。
+		/// </summary>
 		/// <param name="message">メッセージ文字列。</param>
 		/// <param name="connection">接続。</param>
 		public ChatMessage(string message, TcpConnection connection = null)
@@ -39,7 +45,7 @@ namespace SampleChatClient
 		/// </summary>
 		/// <returns>ペイロード長。</returns>
 		/// <param name="header">ヘッダ。</param>
-		public static int ObtainPayloadLength(byte[] header)
+		public override int ObtainPayloadLength(byte[] header)
 		{
 			int payloadLength = header[0] << 8 | header[1];
 
@@ -53,14 +59,15 @@ namespace SampleChatClient
 		/// <param name="data">バイト配列データ。</param>
 		public static ChatMessage FromByteArray(byte[] data)
 		{
+			ChatMessage chatMessage = new ChatMessage();
 			Encoding encoding = new UTF8Encoding(false);
 			// int length = (data[0] << 8) | data[1];
-			byte[] messageData = new byte[data.Length - HeaderLength];
+			byte[] messageData = new byte[data.Length - chatMessage.HeaderLength];
 
-			Array.Copy(data, HeaderLength, messageData, 0, messageData.Length);
-			string message = encoding.GetString(messageData);
+			Array.Copy(data, chatMessage.HeaderLength, messageData, 0, messageData.Length);
+			chatMessage.Message = encoding.GetString(messageData);
 
-			return new ChatMessage(message);
+			return chatMessage;
 		}
 
 		/// <summary>

--- a/src/SocketNet/SampleChatServer/ChatServer.cs
+++ b/src/SocketNet/SampleChatServer/ChatServer.cs
@@ -41,8 +41,7 @@ namespace SampleChatServer
 		/// <param name="port">待ち受けするポート番号。</param>
 		public ChatServer (IPAddress ipAddress, int port)
 		{
-			tcpServer = new TcpServer(ipAddress, port,
-				ChatMessage.HeaderLength, ChatMessage.FooterLength, ChatMessage.ObtainPayloadLength);
+			tcpServer = new TcpServer(ipAddress, port, new ChatMessage());
 			tcpServer.Connected += OnConnected;
 			tcpServer.Disconnected += OnDisconnected;
 			tcpServer.DataReceived += OnDataReceived;

--- /dev/null
+++ b/src/SocketNet/SocketNet/Packet.cs
@@ -0,0 +1,27 @@
+using System;
+
+namespace SocketNet
+{
+	public class Packet
+	{
+		public virtual int HeaderLength { get { return 4; } }
+		public virtual int FooterLength { get { return 0; } }
+
+		public virtual int ObtainPayloadLength(byte[] header)
+		{
+			int payloadLength = 0;
+
+			if (header.Length < HeaderLength)
+			{
+				return 0;
+			}
+			for (int i = 0; i < HeaderLength; i++)
+			{
+				payloadLength = (payloadLength << 8) | header[i];
+			}
+
+			return payloadLength;
+		}
+	}
+}
+

--- a/src/SocketNet/SocketNet/SocketNet.csproj
+++ b/src/SocketNet/SocketNet/SocketNet.csproj
@@ -36,6 +36,7 @@
     <Compile Include="TcpConnectionEventArgs.cs" />
     <Compile Include="TcpDataReceivedEventArgs.cs" />
     <Compile Include="TcpServer.cs" />
+    <Compile Include="Packet.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
 </Project>
\ No newline at end of file

--- a/src/SocketNet/SocketNet/TcpConnection.cs
+++ b/src/SocketNet/SocketNet/TcpConnection.cs
@@ -32,9 +32,7 @@ namespace SocketNet
 	public sealed class TcpConnection: IDisposable
 	{
 		private static readonly int ReceivedDataBufferSize = 65535;
-		private readonly int PacketHeaderLength;
-		private readonly int PacketFooterLength;
-		private readonly ObtainPayloadLengthDelegate ObtainPayloadLength;
+		private readonly Packet Packet = new Packet();
 
 		private object syncObject;
 		private NetworkStream networkStream;
@@ -111,14 +109,8 @@ namespace SocketNet
 		/// コンストラクタ。
 		/// </summary>
 		/// <param name="client">ソケット。</param>
-		/// <param name="headerLength">パケットヘッダ長。</param>
-		/// <param name="footerLength">パケットフッダ長。</param>
-		/// <param name="obtainPayloadLength">ペイロード長取得デリゲート。</param>
-		public TcpConnection(
-			Socket client,
-			int headerLength = 4,
-			int footerLength = 0,
-			ObtainPayloadLengthDelegate obtainPayloadLength = null)
+		/// <param name="packet">受信するパケットの各部の長さの設定を格納するオブジェクト。</param>
+		public TcpConnection(Socket client,	Packet packet)
 		{
 			syncObject = new object();
 			Client = client;
@@ -126,50 +118,17 @@ namespace SocketNet
 			Reader = new BinaryReader(networkStream);
 			Writer = new BinaryWriter(networkStream);
 
-			PacketHeaderLength = headerLength;
-			PacketFooterLength = footerLength;
-
-			if (obtainPayloadLength == null)
-			{
-				ObtainPayloadLength = ObtainPayloadLengthFromHeader;
-			}
-			else
-			{
-				ObtainPayloadLength = obtainPayloadLength;
-			}
+			Packet = packet;
 
 			partiallyReceivedData = new byte[ReceivedDataBufferSize];
 			completelyReceivedData = new List<byte>();
-			header = new byte[headerLength];
+			header = new byte[Packet.HeaderLength];
 			packet = null;
 			packetPayloadLength = 0;
 			bytesToProcessRemaining = 0;
 		}
 
 		/// <summary>
-		/// パケットのペイロード長を、ヘッダから計算して返します
-		/// </summary>
-		/// <returns>ペイロード長。</returns>
-		/// <param name="header">ヘッダを含む配列。</param>
-		/// <remarks>
-		/// ヘッダの先頭に4バイトのペイロード長があるとして、int 型に変換して返します。
-		/// </remarks>
-		private int ObtainPayloadLengthFromHeader(byte[] header)
-		{
-			if (header.Length < 4)
-			{
-				return 0;
-			}
-			int payloadLength = 0;
-			for (int i = 0; i < 4; i++)
-			{
-				payloadLength = (payloadLength << 8) | header[i];
-			}
-
-			return payloadLength;
-		}
-
-		/// <summary>
 		/// 関連付けられたリソースを解放します。
 		/// </summary>
 		public void Dispose()
@@ -278,14 +237,14 @@ namespace SocketNet
 						switch (receiveState)
 						{
 						case DataReceiveState.PacketHeader:
-							if (completelyReceivedData.Count >= PacketHeaderLength)
+							if (completelyReceivedData.Count >= Packet.HeaderLength)
 							{
-								completelyReceivedData.CopyTo(0, header, 0, PacketHeaderLength);
-								packetPayloadLength = ObtainPayloadLength(header);
+								completelyReceivedData.CopyTo(0, header, 0, Packet.HeaderLength);
+								packetPayloadLength = Packet.ObtainPayloadLength(header);
 
 								receiveState = DataReceiveState.PacketPayload;
-								completelyReceivedData.RemoveRange(0, PacketHeaderLength);
-								bytesToProcessRemaining -= PacketHeaderLength;
+								completelyReceivedData.RemoveRange(0, Packet.HeaderLength);
+								bytesToProcessRemaining -= Packet.HeaderLength;
 							}
 							else
 							{
@@ -296,15 +255,15 @@ namespace SocketNet
 						case DataReceiveState.PacketPayload:
 							if (completelyReceivedData.Count >= packetPayloadLength)
 							{
-								packet = new byte[PacketHeaderLength + packetPayloadLength + PacketFooterLength];
-								Array.Copy(header, packet, PacketHeaderLength);
-								completelyReceivedData.CopyTo(0, packet, PacketHeaderLength, packetPayloadLength);
+								packet = new byte[Packet.HeaderLength + packetPayloadLength + Packet.FooterLength];
+								Array.Copy(header, packet, Packet.HeaderLength);
+								completelyReceivedData.CopyTo(0, packet, Packet.HeaderLength, packetPayloadLength);
 
 								receiveState = DataReceiveState.PacketFooter;
 								completelyReceivedData.RemoveRange(0, packetPayloadLength);
 								bytesToProcessRemaining -= packetPayloadLength;
 
-								if (PacketFooterLength == 0)
+								if (Packet.FooterLength == 0)
 								{
 									OnDataReceived(new TcpDataReceivedEventArgs(this, packet));
 									receiveState = DataReceiveState.PacketHeader;
@@ -317,15 +276,15 @@ namespace SocketNet
 							break;
 
 						case DataReceiveState.PacketFooter:
-							if (completelyReceivedData.Count >= PacketFooterLength)
+							if (completelyReceivedData.Count >= Packet.FooterLength)
 							{
-								completelyReceivedData.CopyTo(0, packet, PacketHeaderLength + packetPayloadLength, PacketFooterLength);
+								completelyReceivedData.CopyTo(0, packet, Packet.HeaderLength + packetPayloadLength, Packet.FooterLength);
 
 								OnDataReceived(new TcpDataReceivedEventArgs(this, packet));
 
 								receiveState = DataReceiveState.PacketHeader;
-								completelyReceivedData.RemoveRange(0, PacketFooterLength);
-								bytesToProcessRemaining -= PacketFooterLength;
+								completelyReceivedData.RemoveRange(0, Packet.FooterLength);
+								bytesToProcessRemaining -= Packet.FooterLength;
 							}
 							else
 							{

--- a/src/SocketNet/SocketNet/TcpServer.cs
+++ b/src/SocketNet/SocketNet/TcpServer.cs
@@ -38,9 +38,7 @@ namespace SocketNet
 		/// </summary>
 		public static readonly int MaxPendingConnections = 3;
 
-		private readonly int PacketHeaderLength;
-		private readonly int PacketFooterLength;
-		private readonly TcpConnection.ObtainPayloadLengthDelegate ObtainPayloadLength;
+		private readonly Packet Packet;
 
 		private TcpListener tcpListener;
 		private List<TcpConnection> clientConnections;
@@ -115,18 +113,12 @@ namespace SocketNet
 		/// コンストラクタ。
 		/// </summary>
 		/// <param name="port">バインドするポート。</param>
-		/// <param name="headerLength">ヘッダの長さ。</param>
-		/// <param name="footerLength">フッタの長さ。</param>
-		/// <param name="obtainPayloadLength">ペイロード長取得デリゲート。</param>
+		/// <param name="packet">受信するパケットの各部の長さの設定を格納するオブジェクト。</param>
 		/// <remarks>
 		/// ループバックアドレスを使用します。
 		/// </remarks>
-		public TcpServer(
-			int port,
-			int headerLength = 4,
-			int footerLength = 0,
-			TcpConnection.ObtainPayloadLengthDelegate obtainPayloadLength = null)
-			: this(IPAddress.Loopback, port, headerLength, footerLength, obtainPayloadLength)
+		public TcpServer(int port, Packet packet)
+			: this(IPAddress.Loopback, port, packet)
 		{
 		}
 
@@ -135,22 +127,12 @@ namespace SocketNet
 		/// </summary>
 		/// <param name="ipAddress">バインドするIPアドレス。</param>
 		/// <param name="port">バインドするポート。</param>
-		/// <param name="headerLength">ヘッダの長さ。</param>
-		/// <param name="footerLength">フッタの長さ。</param>
-		/// <param name="obtainPayloadLength">ペイロード長取得デリゲート。</param>
-		public TcpServer(
-			IPAddress ipAddress, 
-			int port,
-			int headerLength = 4,
-			int footerLength = 0,
-			TcpConnection.ObtainPayloadLengthDelegate obtainPayloadLength = null)
+		/// <param name="packet">受信するパケットの各部の長さの設定を格納するオブジェクト。</param>
+		public TcpServer(IPAddress ipAddress, int port, Packet packet)
 		{
-			PacketHeaderLength = headerLength;
-			PacketFooterLength = footerLength;
-			ObtainPayloadLength = obtainPayloadLength;
-
-			Port = port;
 			IPAddress = ipAddress;
+			Port = port;
+			Packet = packet;
 			clientConnections = new List<TcpConnection>();
 			connectionsToClose = new List<TcpConnection>();
 			isShuttingDown = false;
@@ -231,8 +213,7 @@ namespace SocketNet
 
 					await Task.Run(() =>
 						{
-							TcpConnection connection = new TcpConnection(
-								socket, PacketHeaderLength, PacketFooterLength, ObtainPayloadLength);
+							TcpConnection connection = new TcpConnection(socket, Packet);
 							connection.Disconnected += new EventHandler<TcpConnectionEventArgs>(OnDisconnected);
 							connection.DataReceived += new EventHandler<TcpDataReceivedEventArgs>(OnDataReceived);