Socket共通クラス [詳解]

#include <TnbSocket.h>

CAbstractSocket の継承関係図

クラス
struct	IListener
	Socket共通のリスナーインターフェース [詳解]

公開メンバ関数
	CAbstractSocket (void)
	コンストラクタ [詳解]

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

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

virtual DWORD	GetInterfaceId (void) const
	[取得] インターフェース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 bool	Lock (DWORD dwTime=INFINITE) const
	[排他] ロック [詳解]

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

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

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

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

virtual void	SetSocketListener (IListener *piSocketListener)
	[設定] リスナー登録 [詳解]

virtual bool	Start (void)=0
	[操作] 開始. [詳解]

virtual void	Stop (void)=0
	[操作] 停止. [詳解]

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

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

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

静的公開メンバ関数
static CDwordVector	GetMyAddress (void)
	[取得] 自ＩＰアドレス取得. [詳解]

static void	StartUp (void)
	[設定] SOCKET初期化. [詳解]

限定公開メンバ関数
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)
	[出力] ダンプ出力. [詳解]

詳解

Socket共通クラス

ServerとClientの抽象的なクラスです。
ユーザが直接使うことは有りません。

日付: 06/04/01 新規作成; 06/05/11 IReport 実装; 06/06/22 ping処理を CPing クラスに委譲。; 06/07/07 SOCKADDR_INをラッピング; 07/02/09 親クラス変更。; 09/08/27 構成変更。; 09/08/27 アドレス指定に CSocketAddress を使うように変更。; 12/03/13 Socket共通リスナーを先にコールするように変更。; 12/03/30 SetSocketListener() に virtual を付加。

TnbSocket.h の 405 行目に定義があります。

構築子と解体子

◆ CAbstractSocket()

CAbstractSocket ( void )

コンストラクタ

TnbSocket.h の 449 行目に定義があります。

◆ ~CAbstractSocket()

virtual ~CAbstractSocket ( void )

virtual

デストラクタ

TnbSocket.h の 455 行目に定義があります。

関数詳解

◆ 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 行目に定義があります。

◆ GetMyAddress()

static CDwordVector GetMyAddress ( void )

static

[取得] 自ＩＰアドレス取得.

自分のＩＰアドレスを取得します。２つ以上ある場合があります。

戻り値: 自分のＩＰアドレス

TnbSocket.h の 520 行目に定義があります。

◆ GetReportID()

virtual DWORD GetReportID ( void ) const

pure virtualinherited

[取得] コミュニケーションID.

TNBVIW_KIND_??? + PORT を返します。

覚え書き: 開発用のメソッドです。

戻り値: ID

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ GetReportName()

virtual CStr GetReportName ( void ) const

pure virtualinherited

[取得] コミュニケーション名.

覚え書き: 開発用のメソッドです。

戻り値: 名前

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ IsAlive()

virtual bool IsAlive ( void ) const

pure virtualinherited

[確認] Aliveチェック.

各サブクラスの開始メソッドが実行されている状態か、チェックします。

戻り値

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

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ IsConnect()

virtual bool IsConnect ( void ) const

pure virtualinherited

[確認] 接続チェック

戻り値

true	接続中。
false	切断。

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ 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 )

virtualinherited

[設定] パージ.

通信のゴミを浄化

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

IReportを実装しています。

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

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

◆ Send()

virtual bool Send	(	size_t	dataSize,
		LPCVOID	lpcData
	)

pure virtualinherited

[送信] データ送信

引数

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

戻り値

true	成功
false	失敗

CReportWatchAdapter, CBufferingReporter, CCommunicationReporter, CSocketClient, CSocketServer, CSocketUdp, CSocketUdpExで実装されています。

◆ SetIdleEventMode()

virtual void SetIdleEventMode ( int iInterval = 0 )

virtualinherited

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

覚え書き: 受信がない時、指定の間隔でコールバックを発生させることができます。開始後、あるいは受信処理後、指定ms秒後にコールバックが始まります。 Open中に有無の切り替えは可能です。

引数

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

IReportを実装しています。

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

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

◆ SetListener()

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

virtualinherited

[登録] 共通 Listner 登録.

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

引数

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

IReportを実装しています。

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

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

◆ SetSocketListener()

virtual void SetSocketListener ( IListener * piSocketListener )

virtual

[設定] リスナー登録

覚え書き: リスナーを登録しないと受信情報が受けられません; 登録できる CAbstractSocket::IListener は一つだけです。

引数

piSocketListener リスナー

TnbSocket.h の 466 行目に定義があります。

◆ Start()

virtual bool Start ( void )

pure virtualinherited

[操作] 開始.

覚え書き: 設定メソッドで設定を行ってから本メソッドを使用し、開始します。

戻り値

true	成功。Alive状態になりました。
false	失敗。Alive状態にはなれませんでした。

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ StartUp()

static void StartUp ( void )

static

[設定] SOCKET初期化.

WSAStartup() コールします。すでにコールしている場合は、何もしません。

覚え書き: 通常、ソケット使用時に自動的に使用されますので、コールする必要は有りません。 TNB Library 以外のソケット関係を先に使用する場合、WSAStartup() の代わりに使用してください。

TnbSocket.h の 478 行目に定義があります。

◆ Stop()

virtual void Stop ( void )

pure virtualinherited

[操作] 停止.

Alive状態を終了します。

CBufferingReporter, CCommunicationReporter, CReportWatchAdapter, CSocketClient, CSocketServer, CSocketUdpで実装されています。

◆ 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 行目に定義があります。

クラス

公開メンバ関数

静的公開メンバ関数

限定公開メンバ関数

詳解

構築子と解体子

◆ CAbstractSocket()

◆ ~CAbstractSocket()

関数詳解

◆ DisableReportViewer()

◆ GetIdleInterval()

◆ GetInterfaceId()

◆ GetMyAddress()

◆ GetReportID()

◆ GetReportName()

◆ IsAlive()

◆ IsConnect()

◆ Lock()

◆ m_OnEvent()

◆ m_OnSend()

◆ Purge()

◆ Send()

◆ SetIdleEventMode()

◆ SetListener()

◆ SetSocketListener()

◆ Start()

◆ StartUp()

◆ Stop()

◆ ToViewer() [1/2]

◆ ToViewer() [2/2]

◆ Unlock()

◆ WaitConnect()