バッファリングレポータークラス [詳解]
#include <TnbBufferingReporter.h>
CBufferingReporter の継承関係図
公開メンバ関数 | |
| CBufferingReporter (int queueSize=10000) | |
| コンストラクタ [詳解] | |
| 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) |
| [送信] データ送信 [詳解] | |
| void | SetEnvironment (IReport *pReport) |
| [設定] 環境設定. [詳解] | |
| virtual void | SetIdleEventMode (int iInterval=0) |
| [設定] アイドルイベント設定 [詳解] | |
| virtual void | SetListener (IReport::IListener *piCommListener=NULL) |
| [登録] 共通 Listner 登録. [詳解] | |
| virtual bool | Start (void) |
| [操作] 通信レポート開始. [詳解] | |
| virtual void | Stop (void) |
| [操作] 通信レポート停止. [詳解] | |
| virtual void | Unlock (void) const |
| [排他] アンロック [詳解] | |
| bool | WaitConnect (DWORD dwTime) const |
| [確認] 接続待ち [詳解] | |
限定公開メンバ関数 | |
| 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) |
| [出力] ダンプ出力. [詳解] | |
詳解
バッファリングレポータークラス
- 必要ファイル
- TnbBufferingReporter.h
- 日付
- 12/03/13 新規作成
TnbBufferingReporter.h の 35 行目に定義があります。
構築子と解体子
◆ CBufferingReporter()
|
explicit |
関数詳解
◆ DisableReportViewer()
|
inherited |
[設定] レポートビュワー停止.
本メソッドを使用すると、通信ログの出力を行いません。 デフォルトは、出力を行います（ただしビルドの設定にもよります）。
TnbAbstractReport.h の 150 行目に定義があります。
◆ GetIdleInterval()
|
inherited |
◆ GetInterfaceId()
|
virtualinherited |
◆ GetReportID()
|
virtual |
◆ GetReportName()
|
virtual |
◆ IsAlive()
|
virtual |
[確認] Aliveチェック.
Open() メソッドが実行されている状態か、チェックします。
- 戻り値
-
true 開始している。 false 停止している。
IReportを実装しています。
TnbBufferingReporter.h の 94 行目に定義があります。
◆ IsConnect()
|
virtual |
◆ Lock()
|
virtualinherited |
[排他] ロック
- 注意
- 他のクラスのLock()メソッドとは異なり、dwTimeは無視され、 INFINITEとして動作します。つまりどんな値を入れても、ロック 出来るまでリターンされません。
- 引数
-
dwTime 値は無視されます。
- 戻り値
- true 固定
ISynchronizedを実装しています。
CSyncSectionExで再実装されています。
◆ m_OnEvent()
|
protectedinherited |
◆ m_OnSend()
|
protectedinherited |
[内部] 送信情報通知
- 覚え書き
- 処理は開発用TRACEのみ
- 引数
-
sizeData 送信するデータ長。 lpcvData 送信するデータ。
TnbAbstractReport.h の 163 行目に定義があります。
◆ Purge()
|
virtual |
◆ ReferThreadStatus()
| CThreadStatus & ReferThreadStatus | ( | void | ) |
◆ Send()
|
virtual |
[送信] データ送信
- 引数
-
dataSize 送信するデータ長。 lpcvData 送信するデータ。
- 戻り値
-
true 成功。 false 失敗。
IReportを実装しています。
TnbBufferingReporter.h の 183 行目に定義があります。
◆ SetEnvironment()
| void SetEnvironment | ( | IReport * | pReport | ) |
◆ SetIdleEventMode()
|
virtual |
[設定] アイドルイベント設定
- 覚え書き
- 受信がない時、指定の間隔でコールバックを発生させることができます。 開始後、あるいは受信処理後、指定ms秒後にコールバックが始まります。 Open中に有無の切り替えは可能です。
-
SetReceivePollingTiming() とICommunication のサブクラスの
受信待ち時間の 設定に精度が影響されます。
- 引数
-
iInterval Idleイベントをあげる間隔を指定します。０なら、Idleイベントなし。
CAbstractReportを再実装しています。
TnbBufferingReporter.h の 121 行目に定義があります。
◆ SetListener()
|
virtual |
[登録] 共通 Listner 登録.
- 覚え書き
- 登録できる IReport::IListener は一つだけです。
- 引数
-
piCommListener リスナー。省略すると解除になります。
CAbstractReportを再実装しています。
TnbBufferingReporter.h の 62 行目に定義があります。
◆ Start()
|
virtual |
[操作] 通信レポート開始.
- 覚え書き
- 使用している通信クラスで、Openできるように設定後、本メソッドを使用します。
- 戻り値
-
true 成功。 false エラー。 ::GetLastError() で詳細取得可能（その値は SystemErrorToMessageText() で文字列化できます)。
IReportを実装しています。
TnbBufferingReporter.h の 133 行目に定義があります。
◆ Stop()
|
virtual |
◆ ToViewer() [1/2]
|
protectedinherited |
◆ ToViewer() [2/2]
|
protectedinherited |
◆ Unlock()
|
virtualinherited |
◆ WaitConnect()
|
inherited |
