通信アクセスインターフェース [詳解]
#include <TnbReport.h>
IReport の継承関係図
クラス | |
| struct | IListener |
| 通信のリスナーインターフェース [詳解] | |
公開メンバ関数 | |
| virtual DWORD | GetInterfaceId (void) const =0 |
| [取得] インターフェースID取得 [詳解] | |
| virtual DWORD | GetReportID (void) const =0 |
| [取得] コミュニケーションID. [詳解] | |
| virtual CStr | GetReportName (void) const =0 |
| [取得] コミュニケーション名. [詳解] | |
| virtual bool | IsAlive (void) const =0 |
| [確認] Aliveチェック. [詳解] | |
| virtual bool | IsConnect (void) const =0 |
| [確認] 接続チェック [詳解] | |
| virtual void | Purge (void)=0 |
| [設定] パージ. [詳解] | |
| virtual bool | Send (size_t dataSize, LPCVOID lpcData)=0 |
| [送信] データ送信 [詳解] | |
| virtual void | SetIdleEventMode (int iInterval=0)=0 |
| [設定] アイドルイベント設定 [詳解] | |
| virtual void | SetListener (IReport::IListener *piCommListener=NULL)=0 |
| [登録] 共通Listner登録. [詳解] | |
| virtual bool | Start (void)=0 |
| [操作] 開始. [詳解] | |
| virtual void | Stop (void)=0 |
| [操作] 停止. [詳解] | |
| virtual | ~IReport (void) |
| デストラクタ [詳解] | |
詳解
通信アクセスインターフェース
受信は、Listenerを登録し行います。
- 必要ファイル
- TnbReport.h
- 日付
- 06/05/11 新規作成
- 06/07/07 InterfaceID概念、追加
- 06/08/31 CommViewer に対応。
- 06/09/08 Idleイベントサポート。 Purge() / IsAlive() / IsConnect() 追加。 CanAccess() 廃止。
- 07/02/09 抽象化。
- 07/06/11 Start() メソッドを追加。
- 09/04/08 メンバ変数をすべて廃止。メソッドを追加。
- 11/06/14 GetInterfaceId() GetReportID() メソッドの戻り値変更。
TnbReport.h の 226 行目に定義があります。
構築子と解体子
◆ ~IReport()
|
virtual |
デストラクタ
TnbReport.h の 289 行目に定義があります。
関数詳解
◆ GetInterfaceId()
|
pure virtual |
◆ GetReportID()
|
pure virtual |
[取得] コミュニケーションID.
TNBVIW_KIND_??? + PORT を返します。
- 覚え書き
- 開発用のメソッドです。
- 戻り値
- ID
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
◆ GetReportName()
|
pure virtual |
[取得] コミュニケーション名.
- 覚え書き
- 開発用のメソッドです。
- 戻り値
- 名前
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
◆ IsAlive()
|
pure virtual |
[確認] Aliveチェック.
各サブクラスの開始メソッドが実行されている状態か、チェックします。
- 戻り値
-
true 開始している。 false 停止している。
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
◆ IsConnect()
|
pure virtual |
[確認] 接続チェック
- 戻り値
-
true 接続中。 false 切断。
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
◆ Purge()
|
pure virtual |
[設定] パージ.
通信のゴミを浄化
CAbstractReport, CBufferingReporter, CCommunicationReporter, CReportWatchAdapterで実装されています。
◆ Send()
|
pure virtual |
[送信] データ送信
- 引数
-
dataSize 送信するデータ長。 lpcData 送信するデータ。
- 戻り値
-
true 成功 false 失敗
CReportWatchAdapter, CBufferingReporter, CCommunicationReporter, CSocketClient, CSocketServer, CSocketUdp, CSocketUdpExで実装されています。
◆ SetIdleEventMode()
|
pure virtual |
[設定] アイドルイベント設定
- 覚え書き
- 受信がない時、指定の間隔でコールバックを発生させることができます。 開始後、あるいは受信処理後、指定ms秒後にコールバックが始まります。 Open中に有無の切り替えは可能です。
- 引数
-
iInterval Idleイベントをあげる間隔を指定します。０なら、Idleイベントなし。
CAbstractReport, CBufferingReporter, CCommunicationReporter, CReportWatchAdapterで実装されています。
◆ SetListener()
|
pure virtual |
[登録] 共通Listner登録.
- 覚え書き
- 登録できる IReport::IListener は一つだけです。
- 引数
-
piCommListener リスナー。省略すると解除になります。
CAbstractReport, CBufferingReporter, CReportWatchAdapterで実装されています。
◆ Start()
|
pure virtual |
[操作] 開始.
- 覚え書き
- 設定メソッドで設定を行ってから本メソッドを使用し、開始します。
- 戻り値
-
true 成功。Alive状態になりました。 false 失敗。Alive状態にはなれませんでした。
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
◆ Stop()
|
pure virtual |
[操作] 停止.
Alive状態を終了します。
CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。
