SocketNet 1.0 A Socket Networking (C/S) Library

- 総合概要
- パッケージ
- クラス
- ファイル

- クラス一覧
- クラス階層
- クラスメンバ

公開メンバ関数 | 静的公開メンバ関数 | プロパティ | 全メンバ一覧
SampleChatClient.ChatMessage クラス

SampleChatServer.ChatServer と ChatClient 間で送受信されるチャットメッセージを表します。 [詳解]

SampleChatClient.ChatMessage の継承関係図
SampleChatClient.ChatMessage 連携図

## 公開メンバ関数
| ChatMessage ()
| コンストラクタ。 [詳解]
| ChatMessage (string message, TcpConnection connection=null)
| コンストラクタ。 [詳解]
override int | ObtainPayloadLength (byte[] header)
| 指定されたヘッダからペイロード長を取り出します。 [詳解]
byte[] | ToByteArray ()
| チャットメッセージオブジェクトを、バイト配列に変換します。 [詳解]
基底クラス SocketNet.Packet に属する継承公開メンバ関数
| Packet (int headerLength=4, int footerLength=0)
| コンストラクタ。 [詳解]

## 静的公開メンバ関数
static ChatMessage | FromByteArray (byte[] data)
| 指定されたバイト配列からチャットメッセージオブジェクトを生成します。 [詳解]

## プロパティ
TcpConnection | Connection`[get, set]`
| メッセージを送受信する接続を取得または設定します。 [詳解]
string | Message`[get, private set]`
| メッセージ文字列を取得します。 [詳解]
基底クラス SocketNet.Packet に属する継承プロパティ
virtual int | HeaderLength`[get, private set]`
| ヘッダ長を取得します。 [詳解]
virtual int | FooterLength`[get, private set]`
| フッタ長を取得します。 [詳解]

## 詳解

SampleChatServer.ChatServer と ChatClient 間で送受信されるチャットメッセージを表します。

## 構築子と解体子

SampleChatClient.ChatMessage.ChatMessage | ( |  | ) |

コンストラクタ。

参照元 SampleChatClient.ChatMessage.FromByteArray().

被呼び出し関係図:

SampleChatClient.ChatMessage.ChatMessage | ( | string | message,
|  | TcpConnection | connection = `null`
| ) |  |

コンストラクタ。

引数

  message | メッセージ文字列。
  connection | 接続。

参照先 SampleChatClient.ChatMessage.Connection, SampleChatClient.ChatMessage.Message.

## メソッド詳解

static ChatMessage SampleChatClient.ChatMessage.FromByteArray | ( | byte[] | data | ) |
| static

指定されたバイト配列からチャットメッセージオブジェクトを生成します。

戻り値
  チャットメッセージオブジェクト。

引数

  data | バイト配列データ。

参照先 SampleChatClient.ChatMessage.ChatMessage(), SocketNet.Packet.HeaderLength, SampleChatClient.ChatMessage.Message.

参照元 SampleChatServer.ChatServer.OnDataReceived(), SampleChatClient.ChatClient.OnDataReceived().

呼び出し関係図:

被呼び出し関係図:

override int SampleChatClient.ChatMessage.ObtainPayloadLength | ( | byte[] | header | ) |
| virtual

指定されたヘッダからペイロード長を取り出します。

戻り値
  ペイロード長。

引数

  header | ヘッダ。

ベースクラスの Packet.ObtainPayloadLength() と同じことをしているため、 本来ならオーバライドする必要はないが、サンプルとして提供するため実装した。

SocketNet.Packetを再実装しています。

byte [] SampleChatClient.ChatMessage.ToByteArray | ( |  | ) |

チャットメッセージオブジェクトを、バイト配列に変換します。

戻り値
  バイト配列。

参照先 SampleChatClient.ChatMessage.Message.

参照元 SampleChatServer.MainClass.OnChatMessageReceived(), SampleChatClient.ChatClient.Send().

被呼び出し関係図:

## プロパティ詳解

TcpConnection SampleChatClient.ChatMessage.Connection
| get set

メッセージを送受信する接続を取得または設定します。

参照元 SampleChatClient.ChatMessage.ChatMessage(), SampleChatServer.MainClass.OnChatMessageReceived(), SampleChatServer.ChatServer.OnDataReceived(), SampleChatClient.ChatClient.OnDataReceived().

string SampleChatClient.ChatMessage.Message
| get private set

メッセージ文字列を取得します。

参照元 SampleChatClient.ChatMessage.ChatMessage(), SampleChatClient.ChatMessage.FromByteArray(), SampleChatServer.MainClass.OnChatMessageReceived(), MainWindow.OnChatMessageReceived(), SampleChatClient.ChatMessage.ToByteArray().

このクラス詳解は次のファイルから抽出されました:

- ChatMessage.cs