通信インターフェース [詳解]

#include <TnbCommunication.h>

ICommunication の継承関係図

クラス
struct	TProperty
	性能プロパティ型. [詳解]

公開型
enum	EState { OPENNING , CONNECTING , CLOSED }
	状態 [詳解]

公開メンバ関数
virtual bool	CanReceive (void) const
	[確認] 受信可能確認. [詳解]

virtual bool	CanSend (void) const
	[確認] 送信可能確認. [詳解]

virtual EState	Check (void) const
	[確認] チェック. [詳解]

virtual void	Close (void)=0
	[処理] クローズ. [詳解]

virtual const TProperty &	GetProperty (void) const =0
	[取得] 性能取得. [詳解]

virtual size_t	GetReceivingDataSize (void) const
	[確認] 受信データ確認. [詳解]

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

virtual bool	IsOpened (void) const =0
	[確認] オープン確認. [詳解]

virtual bool	Open (void)=0
	[処理] オープン. [詳解]

virtual void	Purge (void)
	[処理] パージ. [詳解]

virtual size_t	Receive (size_t size, LPVOID _P)=0
	[処理] 受信. [詳解]

virtual size_t	Send (size_t size, LPCVOID P)=0
	[処理] 送信. [詳解]

virtual bool	SetReceiveTimeout (DWORD to)=0
	[設定] 受信待ち時間設定. [詳解]

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

詳解

通信インターフェース

送信、受信をサポートするインターフェースを提供します。

必要ファイル: TnbCommunication.h

日付: 07/09/13 新規作成; 10/05/28 SetReceiveTimeout() を新規。

TnbCommunication.h の 33 行目に定義があります。

列挙型メンバ詳解

◆ EState

enum EState

状態

列挙値
OPENNING	オープン状態
CONNECTING	オープン＆接続状態
CLOSED	クローズ状態

TnbCommunication.h の 38 行目に定義があります。

構築子と解体子

◆ ~ICommunication()

virtual ~ICommunication ( void )

virtual

デストラクタ

TnbCommunication.h の 62 行目に定義があります。

関数詳解

◆ CanReceive()

virtual bool CanReceive ( void ) const

virtual

[確認] 受信可能確認.

戻り値

true	受信可能。
false	不可能。

CCeUsbHid, CFileCommunicator, CVmRs232c, CUsbHidで再実装されています。

TnbCommunication.h の 119 行目に定義があります。

◆ CanSend()

virtual bool CanSend ( void ) const

virtual

[確認] 送信可能確認.

戻り値

true	送信可能。
false	不可能。

CCeUsbHid, CFileCommunicator, CVmRs232c, CUsbHidで再実装されています。

TnbCommunication.h の 112 行目に定義があります。

◆ Check()

virtual EState Check ( void ) const

virtual

[確認] チェック.

状態を確認します。

覚え書き: 本クラスでは IsOpened() , IsConnect() を使用します。

戻り値

OPENNING	オープン状態
CONNECTING	オープン＆接続状態
CLOSED	クローズ状態

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CTemporaryCommunicator, CUsbHidで再実装されています。

TnbCommunication.h の 156 行目に定義があります。

◆ Close()

virtual void Close ( void )

pure virtual

[処理] クローズ.

CBluetoothCom, CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CRs232cEx, CTemporaryCommunicator, CUsbHidで実装されています。

◆ GetProperty()

virtual const TProperty & GetProperty ( void ) const

pure virtual

[取得] 性能取得.

覚え書き: 正確な情報は Open後に取得できます。

戻り値: 性能情報

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CRs232cEx, CTemporaryCommunicator, CUsbHidで実装されています。

◆ GetReceivingDataSize()

virtual size_t GetReceivingDataSize ( void ) const

virtual

[確認] 受信データ確認.

覚え書き: 本クラスでは不明を返します。

戻り値

INVALID_SIZE	不明。
上記以外	受信可能データサイズ。

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CTemporaryCommunicator, CUsbHidで再実装されています。

TnbCommunication.h の 146 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void ) const

virtual

[確認] 接続確認.

戻り値

true	接続中。
false	切断中。

CCeUsbHid, CVmRs232c, CRs232c, CUsbHidで再実装されています。

TnbCommunication.h の 105 行目に定義があります。

◆ IsOpened()

virtual bool IsOpened ( void ) const

pure virtual

[確認] オープン確認.

戻り値

true	オープン中。
false	クローズ中。

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CTemporaryCommunicator, CUsbHidで実装されています。

◆ Open()

virtual bool Open ( void )

pure virtual

[処理] オープン.

戻り値

true	成功。
false	失敗。

CBluetoothCom, CCeUsbHid, CCopyDataMessage, CCopyDataPostMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CRs232cEx, CTemporaryCommunicator, CUsbHidで実装されています。

◆ Purge()

virtual void Purge ( void )

virtual

[処理] パージ.

通信のゴミを浄化

覚え書き: 本クラスではなにもしません。

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CTemporaryCommunicator, CUsbHidで再実装されています。

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

◆ Receive()

virtual size_t Receive	(	size_t	size,
		LPVOID	_P
	)

pure virtual

[処理] 受信.

引数

[in]	size	サイズ。
[out]	_P	データ。size 分のメモリは確保しておく必要があります。

戻り値

INVALID_SIZE	エラー。
0	受信データなし。
上記以外	受信データサイズ。

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CRs232cEx, CTemporaryCommunicator, CUsbHidで実装されています。

◆ Send()

virtual size_t Send	(	size_t	size,
		LPCVOID	P
	)

pure virtual

[処理] 送信.

引数

size	サイズ。
P	データ。

戻り値

INVALID_SIZE	エラー。
上記以外	送信データサイズ。

CCeUsbHid, CCopyDataMessage, CCopyDataPostMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CTemporaryCommunicator, CUsbHidで実装されています。

◆ SetReceiveTimeout()

virtual bool SetReceiveTimeout ( DWORD to )

pure virtual

[設定] 受信待ち時間設定.

Receive() 実行時、受信できるデータが無い時に待つ時間を設定できます。

覚え書き: 成功すると、プロパティが変更される可能性があります。

引数

to	タイムアウト時間 (ms)。

戻り値

true	成功。
false	失敗。サポートできない時もこれが返ります。

CCeUsbHid, CCopyDataMessage, CFileCommunicator, CVmRs232c, CPipe, CRs232c, CRs232cEx, CTemporaryCommunicator, CUsbHidで実装されています。

クラス

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ EState

構築子と解体子

◆ ~ICommunication()

関数詳解

◆ CanReceive()

◆ CanSend()

◆ Check()

◆ Close()

◆ GetProperty()

◆ GetReceivingDataSize()

◆ IsConnect()

◆ IsOpened()

◆ Open()

◆ Purge()

◆ Receive()

◆ Send()

◆ SetReceiveTimeout()