Commit: 03db556f2cfe46bfa6a81ea34d28a05eb97dc069 - SocketNet (git)

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

Commit MetaInfo

• Révision: 03db556f2cfe46bfa6a81ea34d28a05eb97dc069 (tree)
• l'heure: 2015-08-15 12:04:23
• Auteur: tsntsumi <tsntsumi@tsnt...>
• Commiter: tsntsumi

Message de Log

Packet クラスをリファクタリング

ヘッダの構造が、デフォルトのヘッダ長 4 バイト、フッタ長 0 バ
イト、ペイロード長 = ヘッダ 4 バイトとは異なる場合、必ず
Packet クラスを継承してプロパティ・メソッドをオーバライドし
なければならなかったが、ヘッダ長とフッタ長とペイロード長の取
得方法が変わった程度の場合ならオーバライドしないでも良いよう
に変更した。

Change Summary

• modified: src/SocketNet/SampleChatClient/ChatMessage.cs
• modified: src/SocketNet/SocketNet/Packet.cs

Modification

--- a/src/SocketNet/SampleChatClient/ChatMessage.cs
+++ b/src/SocketNet/SampleChatClient/ChatMessage.cs
@@ -15,8 +15,6 @@ namespace SampleChatClient
 	/// </summary>
 	public class ChatMessage: Packet
 	{
-		public override int HeaderLength { get { return 2; } }
-
 		/// <summary>
 		/// メッセージを送受信する接続を取得または設定します。
 		/// </summary>
@@ -30,7 +28,7 @@ namespace SampleChatClient
 		/// <summary>
 		/// コンストラクタ。
 		/// </summary>
-		public ChatMessage()
+		public ChatMessage() : base(2, 0)
 		{
 		}
 
@@ -40,6 +38,7 @@ namespace SampleChatClient
 		/// <param name="message">メッセージ文字列。</param>
 		/// <param name="connection">接続。</param>
 		public ChatMessage(string message, TcpConnection connection = null)
+			: base(2, 0)
 		{
 			Message = message;
 			Connection = connection;
@@ -50,6 +49,10 @@ namespace SampleChatClient
 		/// </summary>
 		/// <returns>ペイロード長。</returns>
 		/// <param name="header">ヘッダ。</param>
+		/// <remarks>
+		/// ベースクラスの Packet.ObtainPayloadLength() と同じことをしているため、
+		/// 本来ならオーバライドする必要はないが、サンプルとして提供するため実装した。
+		/// </remarks>
 		public override int ObtainPayloadLength(byte[] header)
 		{
 			int payloadLength = header[0] << 8 | header[1];

--- a/src/SocketNet/SocketNet/Packet.cs
+++ b/src/SocketNet/SocketNet/Packet.cs
@@ -18,12 +18,23 @@ namespace SocketNet
 		/// <summary>
 		/// ヘッダ長を取得します。
 		/// </summary>
-		public virtual int HeaderLength { get { return 4; } }
+		public virtual int HeaderLength { get; private set; }
 
 		/// <summary>
 		/// フッタ長を取得します。
 		/// </summary>
-		public virtual int FooterLength { get { return 0; } }
+		public virtual int FooterLength { get; private set; }
+
+		/// <summary>
+		/// コンストラクタ。
+		/// </summary>
+		/// <param name="headerLength">ヘッダ長。</param>
+		/// <param name="footerLength">フッタ長。</param>
+		public Packet(int headerLength = 4, int footerLength = 0)
+		{
+			HeaderLength = headerLength;
+			FooterLength = footerLength;
+		}
 
 		/// <summary>
 		/// 指定されたヘッダからペイロード長を取得します。
@@ -34,10 +45,11 @@ namespace SocketNet
 		{
 			int payloadLength = 0;
 
-			if (header.Length < HeaderLength)
-			{
-				return 0;
-			}
+			// header は必ず HeaderLength の長さで送られてくるためチェックする必要はない。
+			// if (header.Length < HeaderLength)
+			// {
+			//     return 0;
+			// }
 			for (int i = 0; i < HeaderLength; i++)
 			{
 				payloadLength = (payloadLength << 8) | header[i];