通信レポータクラス [詳解]

#include <TnbCommunicationReporter.h>

CCommunicationReporter の継承関係図

公開メンバ関数
	CCommunicationReporter (ICommunication *pComm, DWORD dwInterfaceId=0)
	コンストラクタ [詳解]

void	DisableReportViewer (void)
	[設定] レポートビュワー停止. [詳解]

int	GetIdleInterval (void) const
	[取得] アイドルイベント間隔取得 [詳解]

virtual DWORD	GetInterfaceId (void) const
	[取得] インターフェースID取得 [詳解]

virtual DWORD	GetReportID (void) const
	[取得] レポート ID. [詳解]

virtual CStr	GetReportName (void) const
	[取得] レポート名. [詳解]

virtual bool	IsAlive (void) const
	[確認] Aliveチェック. [詳解]

virtual bool	IsConnect (void) const
	[確認] 接続されているか [詳解]

virtual bool	Lock (DWORD dwTime=INFINITE) const
	[排他] ロック [詳解]

virtual void	Purge (void)
	[設定] パージ. [詳解]

CThreadStatus &	ReferThreadStatus (void)
	[参照] 受信スレッド状態参照. [詳解]

virtual bool	Send (size_t dataSize, LPCVOID lpcvData)
	[送信] データ送信 [詳解]

virtual void	SetIdleEventMode (int iInterval=0)
	[設定] アイドルイベント設定 [詳解]

virtual void	SetListener (IReport::IListener *piCommListener=NULL)
	[登録] 共通 Listner 登録. [詳解]

void	SetReceivePollingTiming (DWORD dwPollingTiming)
	[設定] 受信チェック間隔設定. [詳解]

virtual bool	Start (void)
	[操作] 通信レポート開始. [詳解]

virtual void	Stop (void)
	[操作] 通信レポート停止. [詳解]

virtual void	Unlock (void) const
	[排他] アンロック [詳解]

bool	WaitConnect (DWORD dwTime) const
	[確認] 接続待ち [詳解]

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

限定公開メンバ関数
bool	m_OnEvent (const CReportEvent &ev)
	[内部] コールバック通知実行 [詳解]

void	m_OnSend (size_t sizeData, LPCVOID lpcvData)
	[内部] 送信情報通知 [詳解]

void	ToViewer (LPCTSTR lpszText)
	[出力] 文字列出力. [詳解]

void	ToViewer (size_t sizeData, LPCVOID lpcvData)
	[出力] ダンプ出力. [詳解]

詳解

通信レポータクラス

ICommunication を包括し、非同期通信をサポートします(IReport インターフェースを提供します）。

覚え書き: CCommunicationReporterT を使用したほうが、テンプレートタイプで包括するため、記述が単純化できます。

必要ファイル: TnbCommunicationReporter.h

日付: 07/09/13 新規作成; 08/10/15 デストラクタ時の Stop を廃止。; 09/08/27 SetReceiveThreadPriority() 追加。構成変更。; 09/09/10 SetReceiveThreadPriority() 廃止、 GetReceiveThreadStatusGet() 追加。; 10/05/28 SetTester() の処理に対応。ポーリング処理改善。; 10/08/05 ITester 廃止。; 11/03/01 デフォルトのポーリング間隔を 1ms に; 11/03/10 ReportEvent_IrregularEnd を追加; 11/06/14 GetReportID() メソッドの戻り型変更。; 11/07/06 送信に失敗していても送信ログがでていたのを修正。

TnbCommunicationReporter.h の 45 行目に定義があります。

構築子と解体子

◆ CCommunicationReporter()

CCommunicationReporter	(	ICommunication *	pComm,
		DWORD	dwInterfaceId = `0`
	)

explicit

コンストラクタ

覚え書き: 本クラスのインスタンスと ICommunication のインスタンスを同じスコープにおく場合、 ICommunication のほうを上に宣言しておくこと（先に構築され、後に破棄されるため）。

引数

pComm	通信クラス。本インスタンスが破棄されるまで、破棄しないでください。
dwInterfaceId	インターフェースID。省略すると０。 (これは、複数の通信クラスで共通のリスナーを使用する時、識別として使用します)

TnbCommunicationReporter.h の 58 行目に定義があります。

◆ ~CCommunicationReporter()

virtual ~CCommunicationReporter ( void )

virtual

デストラクタ

TnbCommunicationReporter.h の 69 行目に定義があります。

関数詳解

◆ DisableReportViewer()

void DisableReportViewer ( void )

inherited

[設定] レポートビュワー停止.

本メソッドを使用すると、通信ログの出力を行いません。デフォルトは、出力を行います（ただしビルドの設定にもよります）。

TnbAbstractReport.h の 150 行目に定義があります。

◆ GetIdleInterval()

int GetIdleInterval ( void ) const

inherited

[取得] アイドルイベント間隔取得

戻り値

0	アイドルイベント発生無し
1以上	間隔(ms)

TnbAbstractReport.h の 107 行目に定義があります。

◆ GetInterfaceId()

virtual DWORD GetInterfaceId ( void ) const

virtualinherited

[取得] インターフェースID取得

戻り値: ID

IReportを実装しています。

TnbAbstractReport.h の 78 行目に定義があります。

◆ GetReportID()

virtual DWORD GetReportID ( void ) const

virtual

[取得] レポート ID.

種類の識別値を返します。

戻り値: ID

IReportを実装しています。

TnbCommunicationReporter.h の 92 行目に定義があります。

◆ GetReportName()

virtual CStr GetReportName ( void ) const

virtual

[取得] レポート名.

戻り値: 名前

IReportを実装しています。

TnbCommunicationReporter.h の 82 行目に定義があります。

◆ IsAlive()

virtual bool IsAlive ( void ) const

virtual

[確認] Aliveチェック.

Open() メソッドが実行されている状態か、チェックします。

戻り値

true	開始している。
false	停止している。

IReportを実装しています。

TnbCommunicationReporter.h の 103 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void ) const

virtual

[確認] 接続されているか

戻り値

true	CTS ON状態。
false	CTS OFF状態。

IReportを実装しています。

TnbCommunicationReporter.h の 113 行目に定義があります。

◆ Lock()

virtual bool Lock ( DWORD dwTime = INFINITE ) const

virtualinherited

[排他] ロック

注意: 他のクラスのLock()メソッドとは異なり、dwTimeは無視され、 INFINITEとして動作します。つまりどんな値を入れても、ロック出来るまでリターンされません。

引数

dwTime 値は無視されます。

戻り値: true 固定

ISynchronizedを実装しています。

CSyncSectionExで再実装されています。

TnbSync.h の 148 行目に定義があります。

◆ m_OnEvent()

bool m_OnEvent ( const CReportEvent & ev )

protectedinherited

[内部] コールバック通知実行

引数

ev 通知する内容

戻り値

true	正常
false	切断要求

TnbAbstractReport.h の 178 行目に定義があります。

◆ m_OnSend()

void m_OnSend	(	size_t	sizeData,
		LPCVOID	lpcvData
	)

protectedinherited

[内部] 送信情報通知

覚え書き: 処理は開発用TRACEのみ

引数

sizeData	送信するデータ長。
lpcvData	送信するデータ。

TnbAbstractReport.h の 163 行目に定義があります。

◆ Purge()

virtual void Purge ( void )

virtual

[設定] パージ.

覚え書き: 通信のゴミを浄化

CAbstractReportを再実装しています。

TnbCommunicationReporter.h の 226 行目に定義があります。

◆ ReferThreadStatus()

CThreadStatus & ReferThreadStatus ( void )

[参照] 受信スレッド状態参照.

戻り値

スレッド状態の参照.

TnbCommunicationReporter.h の 236 行目に定義があります。

◆ Send()

virtual bool Send	(	size_t	dataSize,
		LPCVOID	lpcvData
	)

virtual

[送信] データ送信

引数

dataSize	送信するデータ長。
lpcvData	送信するデータ。

戻り値

true	成功。
false	失敗。

IReportを実装しています。

TnbCommunicationReporter.h の 208 行目に定義があります。

◆ SetIdleEventMode()

virtual void SetIdleEventMode ( int iInterval = 0 )

virtual

[設定] アイドルイベント設定

覚え書き: 受信がない時、指定の間隔でコールバックを発生させることができます。開始後、あるいは受信処理後、指定ms秒後にコールバックが始まります。 Open中に有無の切り替えは可能です。; SetReceivePollingTiming() とICommunication のサブクラスの 受信待ち時間 の設定に精度が影響されます。

引数

iInterval Idleイベントをあげる間隔を指定します。０なら、Idleイベントなし。

CAbstractReportを再実装しています。

TnbCommunicationReporter.h の 128 行目に定義があります。

◆ SetListener()

virtual void SetListener ( IReport::IListener * piCommListener = NULL )

virtualinherited

[登録] 共通 Listner 登録.

覚え書き: 登録できる IReport::IListener は一つだけです。

引数

piCommListener リスナー。省略すると解除になります。

IReportを実装しています。

CBufferingReporterで再実装されています。

TnbAbstractReport.h の 69 行目に定義があります。

◆ SetReceivePollingTiming()

void SetReceivePollingTiming ( DWORD dwPollingTiming )

[設定] 受信チェック間隔設定.

受信情報があるか、ポーリングするタイミングを指定します。

覚え書き: 設定しない場合、1ms になっています。リアルタイム性が高い場合、この値を小さくしないと、送信してから受信までに時間がかかってしまいます。; ICommunication のサブクラスの受信待ち時間 が有効なら、それを有効にし、この受信チェック間隔は 0 にするのがベストです。

引数

dwPollingTiming タイミング(単位;ミリ秒)

TnbCommunicationReporter.h の 142 行目に定義があります。

◆ Start()

virtual bool Start ( void )

virtual

[操作] 通信レポート開始.

覚え書き: 使用している通信クラスで、Openできるように設定後、本メソッドを使用します。

戻り値

true	成功。
false	エラー。 ::GetLastError() で詳細取得可能（その値は SystemErrorToMessageText() で文字列化できます)。

IReportを実装しています。

TnbCommunicationReporter.h の 153 行目に定義があります。

◆ Stop()

virtual void Stop ( void )

virtual

[操作] 通信レポート停止.

覚え書き: 受信用スレッドも停止します。

IReportを実装しています。

TnbCommunicationReporter.h の 189 行目に定義があります。

◆ ToViewer() [1/2]

void ToViewer ( LPCTSTR lpszText )

protectedinherited

[出力] 文字列出力.

引数

lpszText 文字列.

TnbAbstractReport.h の 219 行目に定義があります。

◆ ToViewer() [2/2]

void ToViewer	(	size_t	sizeData,
		LPCVOID	lpcvData
	)

protectedinherited

[出力] ダンプ出力.

引数

sizeData	データサイズ.
lpcvData	データ

TnbAbstractReport.h の 210 行目に定義があります。

◆ Unlock()

virtual void Unlock ( void ) const

virtualinherited

[排他] アンロック

ISynchronizedを実装しています。

TnbSync.h の 155 行目に定義があります。

◆ WaitConnect()

bool WaitConnect ( DWORD dwTime ) const

inherited

[確認] 接続待ち

引数

dwTime 待ち時間(ms)

戻り値

true	接続
false	タイムアウト

TnbAbstractReport.h の 127 行目に定義があります。

公開メンバ関数

限定公開メンバ関数

詳解

構築子と解体子

◆ CCommunicationReporter()

◆ ~CCommunicationReporter()

関数詳解

◆ DisableReportViewer()

◆ GetIdleInterval()

◆ GetInterfaceId()

◆ GetReportID()

◆ GetReportName()

◆ IsAlive()

◆ IsConnect()

◆ Lock()

◆ m_OnEvent()

◆ m_OnSend()

◆ Purge()

◆ ReferThreadStatus()

◆ Send()

◆ SetIdleEventMode()

◆ SetListener()

◆ SetReceivePollingTiming()

◆ Start()

◆ Stop()

◆ ToViewer() [1/2]

◆ ToViewer() [2/2]

◆ Unlock()

◆ WaitConnect()