• R/O
  • HTTP
  • SSH
  • HTTPS

Commit

Frequently used words (click to add to your profile)

javaandroidc++linuxc#objective-ccocoa誰得qtrubybathyscaphegamewindowspythonphpguic翻訳omegattwitterframeworkbtronarduinovb.net計画中(planning stage)directxpreviewertestゲームエンジンdom

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


Commit MetaInfo

Révisionbd9de9b01c03a8a8ea0d9f82b2cbf221e3e17520 (tree)
l'heure2015-08-15 09:18:26
Auteurtsntsumi <tsntsumi@tsnt...>
Commitertsntsumi

Message de Log

自動生成ファイルを除く全要素へのドキュメントコメントの追加

Change Summary

Modification

--- a/src/SocketNet/SampleChatClient/ChatClient.cs
+++ b/src/SocketNet/SampleChatClient/ChatClient.cs
@@ -1,8 +1,16 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// SocketNet ライブラリのサンプルのチャットクライアント。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using System.Net;
38 using System.Net.Sockets;
49 using SocketNet;
510
11+/// <summary>
12+/// SocketNet ライブラリのサンプルプログラム (簡単なチャットクライアント)。
13+/// </summary>
614 namespace SampleChatClient
715 {
816 /// <summary>
--- a/src/SocketNet/SampleChatClient/ChatMessage.cs
+++ b/src/SocketNet/SampleChatClient/ChatMessage.cs
@@ -1,4 +1,9 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// チャットメッセージパケット。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using System.Text;
38 using System.Net;
49 using SocketNet;
@@ -6,7 +11,7 @@ using SocketNet;
611 namespace SampleChatClient
712 {
813 /// <summary>
9- /// <see cref="ChatServer"/> と <see cref="ChatClient"/> 間で送受信されるチャットメッセージを表します。
14+ /// <see cref="SampleChatServer.ChatServer"/> と <see cref="ChatClient"/> 間で送受信されるチャットメッセージを表します。
1015 /// </summary>
1116 public class ChatMessage: Packet
1217 {
--- a/src/SocketNet/SampleChatClient/ChatMessageReceivedEventArgs.cs
+++ b/src/SocketNet/SampleChatClient/ChatMessageReceivedEventArgs.cs
@@ -1,4 +1,9 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// チャットメッセージ庾信イベントのデータ。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using SocketNet;
38
49 namespace SampleChatClient
--- a/src/SocketNet/SampleChatGtkClient/MainWindow.cs
+++ b/src/SocketNet/SampleChatGtkClient/MainWindow.cs
@@ -1,4 +1,9 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// GTK# ベースの簡単なチャットクライアントのウィンドウを実装。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using System.Net;
38 using Gtk;
49 using SocketNet;
@@ -119,8 +124,8 @@ public partial class MainWindow: Gtk.Window
119124 /// <summary>
120125 /// サーバアドレス入力エリアが変更されたときに、接続ボタンの有効・無効を切り替えます。
121126 /// </summary>
122- /// <param name="sender">Sender.</param>
123- /// <param name="e">E.</param>
127+ /// <param name="sender">センダ。</param>
128+ /// <param name="e">イベントデータを格納したオブジェクト。</param>
124129 protected void OnServerAddressEntryChanged(object sender, EventArgs e)
125130 {
126131 connectButton.Sensitive = serverAddressEntry.Text.Length > 0;
--- a/src/SocketNet/SampleChatGtkClient/Program.cs
+++ b/src/SocketNet/SampleChatGtkClient/Program.cs
@@ -1,6 +1,14 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// SocketNet ライブラリのサンプルプログラム (GTK# ベースの簡単なチャットクライアント)。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using Gtk;
38
9+/// <summary>
10+/// SocketNet ライブラリのサンプルプログラム (GTK# ベースの簡単なチャットクライアント)。
11+/// </summary>
412 namespace SampleChatGtkClient
513 {
614 /// <summary>
--- a/src/SocketNet/SampleChatServer/ChatServer.cs
+++ b/src/SocketNet/SampleChatServer/ChatServer.cs
@@ -1,14 +1,22 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// SocketNet ライブラリのサンプルの簡単なチャットサーバ。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using System.Collections.ObjectModel;
38 using System.Collections.Generic;
49 using System.Net;
510 using SocketNet;
611 using SampleChatClient;
712
13+/// <summary>
14+/// SocketNet ライブラリのサンプルプログラム (コンソールベースの簡単なチャットサーバ)。
15+/// </summary>
816 namespace SampleChatServer
917 {
1018 /// <summary>
11- /// <see cref="TcpServer"/> クラスを利用したチャットサーバ。
19+ /// <see cref="SocketNet.TcpServer"/> クラスを利用したチャットサーバ。
1220 /// </summary>
1321 public class ChatServer
1422 {
@@ -66,6 +74,7 @@ namespace SampleChatServer
6674 /// <summary>
6775 /// 接続イベントを発行します。
6876 /// </summary>
77+ /// <param name="sender">センダ。</param>
6978 /// <param name="e">イベントデータを格納したオブジェクト。</param>
7079 private void OnConnected(object sender, TcpConnectionEventArgs e)
7180 {
--- a/src/SocketNet/SampleChatServer/Program.cs
+++ b/src/SocketNet/SampleChatServer/Program.cs
@@ -1,4 +1,9 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// コンソールベースの簡単なチャットサーバ。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27 using System.Text;
38 using System.Net;
49 using SocketNet;
--- a/src/SocketNet/SocketNet/Packet.cs
+++ b/src/SocketNet/SocketNet/Packet.cs
@@ -1,12 +1,35 @@
1-using System;
1+/// @file
2+/// <summary>
3+/// パケットの定数を提供するクラス。
4+/// </summary>
5+/// @since 2015.8.14
6+using System;
27
38 namespace SocketNet
49 {
10+ /// <summary>
11+ /// パケットのヘッダ長、フッタ長、ペイロード長を取得するためのプロパティ・メソッドを実装するクラス。
12+ /// </summary>
13+ /// <remarks>
14+ /// 各長さを変更する場合は、このクラスから継承してプロパティ・メソッドをオーバライドします。
15+ /// </remarks>
516 public class Packet
617 {
18+ /// <summary>
19+ /// ヘッダ長を取得します。
20+ /// </summary>
721 public virtual int HeaderLength { get { return 4; } }
22+
23+ /// <summary>
24+ /// フッタ長を取得します。
25+ /// </summary>
826 public virtual int FooterLength { get { return 0; } }
927
28+ /// <summary>
29+ /// 指定されたヘッダからペイロード長を取得します。
30+ /// </summary>
31+ /// <returns>ペイロード長。</returns>
32+ /// <param name="header">ヘッダ。</param>
1033 public virtual int ObtainPayloadLength(byte[] header)
1134 {
1235 int payloadLength = 0;
--- a/src/SocketNet/SocketNet/TcpConnection.cs
+++ b/src/SocketNet/SocketNet/TcpConnection.cs
@@ -1,5 +1,6 @@
1-/// <summary>
2-/// TCP/IP の接続。
1+/// @file
2+/// <summary>
3+/// TCP/IP の接続を表現します。
34 /// </summary>
45 /// @since 2015.8.12
56 using System;
--- a/src/SocketNet/SocketNet/TcpConnectionEventArgs.cs
+++ b/src/SocketNet/SocketNet/TcpConnectionEventArgs.cs
@@ -1,4 +1,5 @@
1-/// <summary>
1+/// @file
2+/// <summary>
23 /// TCP 接続イベント引数。
34 /// </summary>
45 /// @since 2015.8.12
--- a/src/SocketNet/SocketNet/TcpDataReceivedEventArgs.cs
+++ b/src/SocketNet/SocketNet/TcpDataReceivedEventArgs.cs
@@ -1,4 +1,5 @@
1-/// <summary>
1+/// @file
2+/// <summary>
23 /// TCP データ受信イベント引数。
34 /// </summary>
45 /// @since 2015.8.12
--- a/src/SocketNet/SocketNet/TcpServer.cs
+++ b/src/SocketNet/SocketNet/TcpServer.cs
@@ -1,4 +1,5 @@
1-/// <summary>
1+/// @file
2+/// <summary>
23 /// マルチスレッド TCP サーバ。
34 /// </summary>
45 /// @since 2015/8/12