パケットコマンダー. [詳解]

#include <TnbPacketCommander.h>

CPacketCommander の継承関係図

クラス
struct	IListener
	パケットコマンダーのリスナー [詳解]

公開型
enum	EFailure { Timeout = -1 , SendError = -2 , Canceled = -3 , NotOpen = -4 }
	失敗種類 [詳解]

公開メンバ関数
void	CancelWaitResponse (DWORD threadId=0)
	[設定] レスポンス待ちキャンセル. [詳解]

virtual void	Close (void)
	[設定] クローズ. [詳解]

	CPacketCommander (int iQueueSize=10000)
	コンストラクタ [詳解]

virtual int	ExecuteCommand (IPacketCommandExecuter::IPacket &_response, const IPacketCommandExecuter::IPacket &command, DWORD timeout=500)
	[実行] コマンド実行. [詳解]

int	ExecuteCommand_Start (IPacketCommandExecuter::IPacket &_response, const IPacketCommandExecuter::IPacket &command)
	[実行] コマンド実行(開始). [詳解]

void	ExecuteCommand_Stop (IPacketCommandExecuter::IPacket &response)
	[実行] コマンド実行(終了). [詳解]

int	ExecuteCommand_Wait (IPacketCommandExecuter::IPacket &_response, DWORD timeout=500)
	[実行] コマンド実行(待ち). [詳解]

void	ExtendTimeout (DWORD threadId=0)
	[設定] タイムアウト延長. [詳解]

void	ExtendTimeoutEx (DWORD time, DWORD threadId=0)
	[設定] タイムアウト延長. [詳解]

size_t	GetQueueFreeSize (void) const
	[取得] キュー空きサイズ取得. [詳解]

bool	IsConnect (void) const
	[取得] 接続確認. [詳解]

bool	IsOpened (void) const
	[取得] オープン確認. [詳解]

bool	Open (IReport *pRep, bool withQueueing=false)
	[設定] オープン. [詳解]

void	PurgeQueue (void)
	[設定] キュークリア [詳解]

IReport *	ReferReporter (void)
	[参照] レポーター参照. [詳解]

int _deprecated	SendCommand (const IPacketCommandExecuter::IPacket &packet)
	[実行] パケット送信. [詳解]

virtual int	SendPacket (const IPacketCommandExecuter::IPacket &packet)
	[実行] パケット送信. [詳解]

bool	SendRawData (size_t size, const BYTE *pData)
	[送信] 生データ送信. [詳解]

void	SetAliveTime (DWORD time=DWORD_MAX)
	[設定] キュー有効時間設定. [詳解]

void _deprecated	SetBasicPacket (IPacketCommandExecuter::IPacket *pPacket)
	[設定] 解析用パケット指定. [詳解]

void	SetListener (IListener *pListener)
	[設定] リスナー設定. [詳解]

void	SetPacketFormat (IPacketCommandExecuter::IPacket *pPacket)
	[設定] 解析用パケット指定. [詳解]

void	SetTearminalTime (DWORD time=DWORD_MAX)
	[設定] 終端時間設定. [詳解]

	~CPacketCommander (void)
	デストラクタ [詳解]

詳解

パケットコマンダー.

コマンド送信〜応答待ちまでをサポートしています。タイムアウト時間は、 ExecuteCommand() メソッドで指定可能です。

まず、パケットの形を IPacketCommandExecuter::IPacket を実装して作成します(ex;CBasicPacket)。これは、 STX〜ETX や改行区切りなど、BYTE 列を解析する機能とパケットを作成する機能を持つものです。
//

// パケットフォーマット型.

//

// パケットの形のみを管理する。

// @note STX[1], LEN[1], CMD[1], DAT[LEN-2], BCC[1], ETX[1]\n

// - BCCはLEN〜DATの合計

// コマンドコード種、データの中身、長さは、チェックしない。

//

class CPacketFormat : public TNB::CPacketCommander::IPacket

{

public:

// SetData() エラーコード

enum

{

NotFoundStx = -100, // STX が見つからない

NotFoundEtx = -101, // ETX が見つからない

InvalidBcc = -103, // BCC異常

InvalidParameter = -104, // パラメータ異常

};

//

// コンストラクタ.

// @param cc コマンドコード。省略すると０。

//

CPacketFormat(BYTE cc = 0) : m_command(cc);

//

// [設定] コマンドコード設定

// @param cc コマンドコード

//

void SetCommand(BYTE cc);

//

// [取得] コマンドコード取得

// @return コマンドコード

//

BYTE GetCommand(void) const;

//

// [取得] データ取得.

// @return データ

//

const CByteVector& GetData(void) const;

//

// [設定] データ設定.

// @param vb データ

// @retval 0 成功

// @retval マイナスエラー。

//

int SetDataV(const CByteVector& vb);

//

// [設定] データ設定.

// @param len データ長

// @param P データ

// @retval 0 成功

// @retval マイナスエラー。

//

virtual int SetData(size_t len, LPCVOID P);

//

// [取得] シリアライズ.

// 本インスタンスで保持している情報から、シーケンシャルデータを作成します。

// @return シーケンシャルデータ.

//

virtual CByteVector Serialize(void) const;

//

// [設定] デシリアライズ.

// 指定のシーケンシャルデータを解析し、パケットを取り出し本インスタンスに格納します。

// @param c データ

// @retval 0 パケット判断できるだけの長さがない

// @retval 0未満パケット解析エラー。

// @retval 1以上パケット解析成功。値は解析に使用したデータ長さ。

//

virtual int Deserialize(const IConstCollectionT<BYTE>& c);

//

// [取得] 文字列化.

// コマンド名、パラメータを文字列化します。

// @return 文字列。任意ですが、通常[0]はコマンド名。以降はパラメータとします。

//

virtual CStrVector ToStrings(void) const;

protected:

enum

{

STX = 0x02, // STX

ETX = 0x03, // ETX

};

BYTE m_command; // コマンド

CByteVector m_data; // データ

friend class CPacketTest;

};

TNB::CByteVector
TNB::CVectorT< BYTE > CByteVector
BYTE配列管理クラス
Definition: TnbVector.h:1122

TNB::CStrVector
TNB::CVectorT< CStr > CStrVector
文字列配列管理クラス
Definition: TnbStrVector.h:31

TNB::IPacketCommandExecuter::IPacket
パケットインターフェース.
Definition: TnbPacketCommander.h:324
それのインスタンスを SetPacketFormat() に渡します。
更に IPacket を実装した個々のコマンドごとに管理パケットクラスを作成します(ex; CVersionCommand )。このクラスは、決められたコマンドコードなど、正しくなければ、解析でエラーを返すようにします。
以下は個々のコマンドの抽象クラス例。必要に応じて継承し AnalyzeData をオーバーロードする。
//

// 抽象パケット管理クラス.

//

class CAbstractPacket : public CPacketFormat

{

DEFSUPER(CPacketFormat);

public:

// SetData() エラーコード

enum

{

UnknownCommandCode = -201, // コマンドコード不明

};

//

// [設定] パケット設定.

// @param bp パケット情報

// @retval 0 成功

// @retval マイナスパケット解析エラー。

//

int SetPacket(const CBasicPacket& bp);

//

// [設定] デシリアライズ.

// 指定のシーケンシャルデータを解析し、パケットを取り出し本インスタンスに格納します。

// @param c データ

// @retval 0 パケット判断できるだけの長さがない

// @retval 0未満パケット解析エラー。

// @retval 1以上パケット解析成功。値は解析に使用したデータ長さ。

//

virtual int Deserialize(const IConstCollectionT<BYTE>& c);

//

// [設定] データ設定.

// @param len データ長

// @param P データ

// @retval 0 データ部解析成功

// @retval マイナスデータ部解析エラー。

//

virtual int SetData(size_t len, LPCVOID P);

//

// [取得] 文字列化.

// コマンド名、パラメータを文字列化します。

// @return 文字列。任意ですが、通常[0]はコマンド名。以降はパラメータとします。

//

virtual CStrVector ToStrings(void) const;

//

// [取得] コマンド名取得.

// @return コマンド名.

//

CStr GetCommandName(void) const;

//

// [取得] リザルト値取得.

// @return リザルト値.

//

virtual BYTE GetResult(void) const;

protected:

//

// 初期化.

// @param cc コマンドコード。

// @param lpszName コマンド名.

//

void Init(BYTE cc, LPCTSTR lpszName);

CStr m_commandName; // コマンド名

private:

void SetCommand(BYTE cc);

};

// バージョン確認コマンド

class CVersionCommand : public CAbstractPacket

{

public:

enum { CC = 0x2A }; // コマンドコード

// コンストラクタ

CVersionCommand(void)

{

Init(CC, _T("バージョン確認コマンド"));

}

};

// バージョン確認レスポンスデータ

struct TVersionData

{

TPacByte result; // 0x00; 成功 0x01; パラメータエラー

char name[13]; // 名前

TPacByte version[4]; // バージョン

//

// [取得] 文字列化

// @return 文字列

//

CStrVector ToStrings(void) const;

};

class CVersionResponse : public CAbstractParamPacketT<TVersionData>

{

public:

enum { CC = 0xAA }; // コマンドコード

// コンストラクタ

CVersionResponse(void)

{

Init(CC, _T("バージョン確認レスポンス"));

}

//

// [設定] パラメータ設定.

// @param prm パラメータ.

//

virtual void SetParameter(const TParam& prm);

{

m_param = prm;

int cnt = 1;

if ( m_param.result == 0 )

{

cnt = sizeof(TFwVersionData);

}

m_data.SetElements(cnt , reinterpret_cast<const BYTE*>(&m_param));

}

// リザルト取得

virtual BYTE GetResult(void) const

{

return GetParameter().result;

}

protected:

//

// [解析] データ部解析.

// @param len データ長さ

// @param P データ.

// @retval 0 データ部解析成功

// @retval マイナスデータ部解析エラー。

//

virtual int SetData(size_t len, LPCVOID P)

{

m_data.SetElements(len, static_cast<const BYTE*>(P));

if ( len >= 1 )

{

Zero(m_param);

const BYTE* B = static_cast<const BYTE*>(P);

BYTE r = B[0]; // result;

size_t l = (r == 0) ? sizeof(TFwVersionData) : 1;

if ( l == len )

{

memcpy(&m_param, P, l);

return 0;

}

}

return InvalidParameter;

}

};

TNB::CStr
TNB::CStrT< TCHAR > CStr
文字列クラス
Definition: TnbStr.h:1785

TNB::Zero
void Zero(V &value)
[設定] ゼロクリア.
Definition: TnbDef.h:399
ExecuteCommand() で、送信するパケットと、期待する受信パケットを引数にコールする。
CVersionCommand pc;

CVersionResponse pr;

m_commander.ExecuteCommand(pr, pc, 1000);

成功すると、 pr に受信した内容が入っている。

必要ファイル: TnbPacketCommander.h

日付: 10/08/24 新規作成; 11/01/18 大幅改築; 11/03/04 ExecuteCommand() の応答待ち中のキャンセルを追加; 11/07/05 SendRawData() , SetLogger() 追加。 ILogger 、追加。; 11/07/06 NotOpen を追加。; 11/07/06 SetLogger() ILogger 、廃止。; 11/07/13 SetAliveTime() 追加。; 11/09/20 タイムアウト等で破棄されたデータもきちんとリスナーに上げるように修正。; 12/02/29 SendCommand() -> SendPacket() 。 SetBasicPacket() -> SetPacketFormat(); 12/03/23 IListener::OnCommanderReceivedExpectationPacket() に対応。; 14/05/16 IsConnect() 、追加。; 15/02/20 SetTearminalTime() 追加。; 15/03/18 ExecuteCommand() を分解したメソッド（Start, Wait, Stop）を追加。; 18/09/22 PurgeQueue() 、追加。

TnbPacketCommander.h の 654 行目に定義があります。

列挙型メンバ詳解

◆ EFailure

enum EFailure

失敗種類

列挙値
Timeout	タイムアウト
SendError	送信エラー
Canceled	キャンセル
NotOpen	オープンしてない

TnbPacketCommander.h の 659 行目に定義があります。

構築子と解体子

◆ CPacketCommander()

CPacketCommander ( int iQueueSize = 10000 )

コンストラクタ

引数

iQueueSize 受信Byteキューのサイズ。省略すると10000です。

TnbPacketCommander.h の 724 行目に定義があります。

◆ ~CPacketCommander()

~CPacketCommander ( void )

デストラクタ

TnbPacketCommander.h の 729 行目に定義があります。

関数詳解

◆ CancelWaitResponse()

void CancelWaitResponse ( DWORD threadId = 0 )

[設定] レスポンス待ちキャンセル.

覚え書き: ExecuteCommand() で応答待ちを、このメソッドでとめることができます。その場合、 ExecuteCommand() の戻り値は Canceled(-4) になります。

引数

threadId スレッドID。省略すると、全てのタスクをキャンセル。

TnbPacketCommander.h の 1068 行目に定義があります。

◆ Close()

virtual void Close ( void )

virtual

[設定] クローズ.

覚え書き: オープンしていなければ何もしません。

TnbPacketCommander.h の 849 行目に定義があります。

◆ ExecuteCommand()

virtual int ExecuteCommand	(	IPacketCommandExecuter::IPacket &	_response,
		const IPacketCommandExecuter::IPacket &	command,
		DWORD	timeout = `500`
	)

virtual

[実行] コマンド実行.

コマンドパケットを送信し、応答があるか、タイムアウトするまで関数はリターンしません。

覚え書き: コマンドパケットに生成する Serialize で Empty を返すクラスを渡すと送信しないので、レスポンス待ちのみできます。

引数

[out]	_response	レスポンス型。成功時、結果が格納されます。
[in]	command	コマンド型。
[in]	timeout	レスポンスのタイムアウト時間(ms).

戻り値

0以上	成功。
Timeout	タイムアウト。
SendError	送信エラー。
NotOpen	未オープン。
0未満	その他のエラー(主に IPacketCommandExecuter::IPacket::Deserialize() の戻り値)。

IPacketCommandExecuterを実装しています。

TnbPacketCommander.h の 915 行目に定義があります。

◆ ExecuteCommand_Start()

int ExecuteCommand_Start	(	IPacketCommandExecuter::IPacket &	_response,
		const IPacketCommandExecuter::IPacket &	command
	)

[実行] コマンド実行(開始).

コマンドパケットを送信し、応答待ち準備をします。

覚え書き: 通常 ExecuteCommand() を使用し、本メソッドは使用しません。

引数

[out]	_response	レスポンス型。成功時、結果が格納されます。
[in]	command	コマンド型。

戻り値

0以上	成功。終了後、必ず ExecuteCommand_Stop() をコールしてください。
Timeout	タイムアウト。
SendError	送信エラー。
NotOpen	未オープン。
0未満	その他のエラー(主に IPacketCommandExecuter::IPacket::Deserialize() の戻り値)。

TnbPacketCommander.h の 938 行目に定義があります。

◆ ExecuteCommand_Stop()

void ExecuteCommand_Stop ( IPacketCommandExecuter::IPacket & response )

[実行] コマンド実行(終了).

ExecuteCommand_Start() を使った場合、必ず本メソッドを使用してください。

引数

response レスポンス型。ExecuteCommand_Start() と同じオブジェクトを使用してください。

TnbPacketCommander.h の 1028 行目に定義があります。

◆ ExecuteCommand_Wait()

int ExecuteCommand_Wait	(	IPacketCommandExecuter::IPacket &	_response,
		DWORD	timeout = `500`
	)

[実行] コマンド実行(待ち).

応答があるか、タイムアウトするまで関数はリターンしません。

覚え書き: 通常 ExecuteCommand() を使用し、本メソッドは使用しません。

引数

[out]	_response	レスポンス型。成功時、結果が格納されます。 ExecuteCommand_Start() と同じオブジェクトを使用してください。
[in]	timeout	レスポンスのタイムアウト時間(ms).

戻り値

0以上	成功。
Timeout	タイムアウト。
SendError	送信エラー（ExecuteCommand_Start() が成功していない）。
NotOpen	未オープン。
0未満	その他のエラー(主に IPacketCommandExecuter::IPacket::Deserialize() の戻り値)。

TnbPacketCommander.h の 976 行目に定義があります。

◆ ExtendTimeout()

void ExtendTimeout ( DWORD threadId = 0 )

[設定] タイムアウト延長.

コマンドの応答待ちを延長します。これをコールした時にタイムアウト時間の再設定が行われます（例えば、タイムアウト5秒の設定の場合で、コマンド送信後、 2秒後に本メソッドをコールすると、全部で７秒間、レスポンスを待ちます）。

覚え書き: リスナー内や、別スレッドから使用します。

引数

threadId スレッドID。省略すると、全てのタスクを延長。

TnbPacketCommander.h の 1045 行目に定義があります。

◆ ExtendTimeoutEx()

void ExtendTimeoutEx	(	DWORD	time,
		DWORD	threadId = `0`
	)

[設定] タイムアウト延長.

コマンドの応答待ちを指定時間、延長します。

覚え書き: リスナー内や、別スレッドから使用します。

引数

time	延長する時間(ms)
threadId	スレッドID。省略すると、全てのタスクを延長。

TnbPacketCommander.h の 1057 行目に定義があります。

◆ GetQueueFreeSize()

size_t GetQueueFreeSize ( void ) const

[取得] キュー空きサイズ取得.

戻り値: 空きサイズ

TnbPacketCommander.h の 1100 行目に定義があります。

◆ IsConnect()

bool IsConnect ( void ) const

[取得] 接続確認.

戻り値

true	接続.
false	切断.

TnbPacketCommander.h の 808 行目に定義があります。

◆ IsOpened()

bool IsOpened ( void ) const

[取得] オープン確認.

戻り値

true	オープン済み.
false	未オープン.

TnbPacketCommander.h の 794 行目に定義があります。

◆ Open()

bool Open	(	IReport *	pRep,
		bool	withQueueing = `false`
	)

[設定] オープン.

覚え書き: 指定のレポータを使用してオープンします。; 解析用パケットを登録していないと失敗します。

引数

pRep	レポータ。クローズするまで破棄しないでください。
withQueueing	ture ならキューを使います。

戻り値

true	成功.
false	失敗.

TnbPacketCommander.h の 826 行目に定義があります。

◆ PurgeQueue()

void PurgeQueue ( void )

[設定] キュークリア

TnbPacketCommander.h の 1108 行目に定義があります。

◆ ReferReporter()

IReport * ReferReporter ( void )

[参照] レポーター参照.

戻り値

NULL	未使用
NULL以外	使用しているレポーター。

TnbPacketCommander.h の 1118 行目に定義があります。

◆ SendCommand()

int _deprecated SendCommand ( const IPacketCommandExecuter::IPacket & packet )

[実行] パケット送信.

引数

packet パケット

戻り値

0以上	成功。
SendError	送信エラー。
NotOpen	未オープン。

非推奨:: 廃止予定です。 SendPacket() を使用してください。

TnbPacketCommander.h の 897 行目に定義があります。

◆ SendPacket()

virtual int SendPacket ( const IPacketCommandExecuter::IPacket & packet )

virtual

[実行] パケット送信.

覚え書き: リスナーで受けたメソッドからも使用できます。

引数

packet パケット

戻り値

0以上	成功。
SendError	送信エラー。
NotOpen	未オープン。

IPacketCommandExecuterを実装しています。

TnbPacketCommander.h の 867 行目に定義があります。

◆ SendRawData()

bool SendRawData	(	size_t	size,
		const BYTE *	pData
	)

[送信] 生データ送信.

任意のデータを送信することが出来ます。

引数

size	サイズ
pData	データ

戻り値

true	成功.
false	失敗.

TnbPacketCommander.h の 1081 行目に定義があります。

◆ SetAliveTime()

void SetAliveTime ( DWORD time = DWORD_MAX )

[設定] キュー有効時間設定.

キュー格納後、一定時間受信がない場合、キュー内容を破棄することが出来ます。

覚え書き: Open() 時、キューを使うを指定してない場合、この設定は無意味です。; SetTearminalTime() と同時に指定できません。

引数

time	キューの有効時間(ms)。最後に受信して解析してから指定時間経過したら、キューの先頭の一バイトを破棄して、再度解析をします。省略時は無効( DWORD_MAX )です。

TnbPacketCommander.h の 772 行目に定義があります。

◆ SetBasicPacket()

void _deprecated SetBasicPacket ( IPacketCommandExecuter::IPacket * pPacket )

[設定] 解析用パケット指定.

引数

pPacket パケット

非推奨:: 廃止予定です。 SetPacketFormat() を使用してください。

TnbPacketCommander.h の 750 行目に定義があります。

◆ SetListener()

void SetListener ( IListener * pListener )

[設定] リスナー設定.

引数

pListener リスナー

TnbPacketCommander.h の 759 行目に定義があります。

◆ SetPacketFormat()

void SetPacketFormat ( IPacketCommandExecuter::IPacket * pPacket )

[設定] 解析用パケット指定.

注意: 本メソッドで指定したインスタンスは本クラス内で使用しますので、操作することはしないでください。

引数

pPacket パケット

TnbPacketCommander.h の 740 行目に定義があります。

◆ SetTearminalTime()

void SetTearminalTime ( DWORD time = DWORD_MAX )

[設定] 終端時間設定.

キュー格納後、一定時間受信がない場合にキュー内容を解析するようにします。

覚え書き: Open() 時、キューを使うを指定してない場合、この設定は無意味です。; SetAliveTime() と同時に指定できません。

引数

time 終端時間(ms)。

TnbPacketCommander.h の 784 行目に定義があります。

クラス

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ EFailure

構築子と解体子

◆ CPacketCommander()

◆ ~CPacketCommander()

関数詳解

◆ CancelWaitResponse()

◆ Close()

◆ ExecuteCommand()

◆ ExecuteCommand_Start()

◆ ExecuteCommand_Stop()

◆ ExecuteCommand_Wait()

◆ ExtendTimeout()

◆ ExtendTimeoutEx()

◆ GetQueueFreeSize()

◆ IsConnect()

◆ IsOpened()

◆ Open()

◆ PurgeQueue()

◆ ReferReporter()

◆ SendCommand()

◆ SendPacket()

◆ SendRawData()

◆ SetAliveTime()

◆ SetBasicPacket()

◆ SetListener()

◆ SetPacketFormat()

◆ SetTearminalTime()