TNB Library
公開メンバ関数 | 静的公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
CSocketClient クラス

Socketクライアントクラス [詳解]

#include <TnbSocket.h>

+ CSocketClient の継承関係図

公開メンバ関数

bool Connect (const CSocketAddress &address)
 [実行] 開始 [詳解]
 
 CSocketClient (bool isAutoReconnect=true)
 コンストラクタ [詳解]
 
void DisableReportViewer (void)
 [設定] レポートビュワー停止. [詳解]
 
void Disconnect (void)
 [実行] 切断 [詳解]
 
int GetIdleInterval (void) const
 [取得] アイドルイベント間隔取得 [詳解]
 
virtual DWORD GetInterfaceId (void) const
 [取得] インターフェースID取得 [詳解]
 
virtual DWORD GetReportID (void) const
 [取得] コミュニケーションID. [詳解]
 
virtual CStr GetReportName (void) const
 [取得] コミュニケーション名. [詳解]
 
SOCKET GetSocket (void) const
 [取得] ソケット取得 [詳解]
 
virtual bool IsAlive (void) const
 [確認] Aliveチェック. [詳解]
 
virtual bool IsConnect (void) const
 [確認] 接続確認 [詳解]
 
virtual bool Lock (DWORD dwTime=INFINITE) const
 [排他] ロック [詳解]
 
virtual void Purge (void)
 [設定] パージ. [詳解]
 
CThreadStatusReferThreadStatus (void)
 [設定] 受信スレッド状態種取得. [詳解]
 
virtual bool Send (size_t dataSize, LPCVOID lpcvData)
 [実行] 送信 [詳解]
 
void SetDelayMode (bool boIsDelay)
 [設定] 送信遅延モード設定 [詳解]
 
virtual void SetIdleEventMode (int iInterval=0)
 [設定] アイドルイベント設定 [詳解]
 
virtual void SetListener (IReport::IListener *piCommListener=NULL)
 [登録] 共通 Listner 登録. [詳解]
 
void SetServer (const CSocketAddress &address)
 [設定] サーバ設定 [詳解]
 
virtual void SetSocketListener (IListener *piSocketListener)
 [設定] リスナー登録 [詳解]
 
virtual bool Start (void)
 [実行] 開始 [詳解]
 
virtual void Stop (void)
 [実行] 切断 [詳解]
 
virtual void Unlock (void) const
 [排他] アンロック [詳解]
 
bool WaitConnect (DWORD dwTime) const
 [確認] 接続待ち [詳解]
 
virtual ~CSocketClient (void)
 デストラクタ [詳解]
 

静的公開メンバ関数

static CDwordVector GetMyAddress (void)
 [取得] 自IPアドレス取得. [詳解]
 
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を探す自動接続モードもあります。

受信は CAbstractSocket::IListener のサブクラスを登録し行います。
( IReport::IListener でも受信は出来ますが基本機能しかありません)
覚え書き
リスナー内で SendMessage を使う場合、 ReferThreadStatus()関連ウィンドウを指定する 必要があります。 CThread::SetOwnerHwnd() を参照してください。
必要ファイル
TnbSocket.h
日付
06/04/01 新規作成
06/04/27 メソッドでの切断でもDisconnectイベントがあがるようにした。
06/06/07 connectのタイムアウト時間を調整。
06/06/22 pingによる切断監視を追加。
06/07/31 「Start時にサーバアドレスを得ていたため、そこでつながっていないと二度とつながらない」現象を修正。
06/08/31 CommViewer に対応。
06/09/08 Idleイベントサポート。 IsAlive() / IsConnect() 追加。 CanAccess() 廃止。
07/02/23 Connect時、名前が解決できないと、自動モードなのにつながらなくなるのを修正。
07/06/11 親クラスの Start() メソッドに対応。
09/02/27 リトライ待ち処理を改善。
09/08/27 SetReceiveThreadPriority() 追加。構成変更。
09/08/27 アドレス指定に CSocketAddress を使うように変更。
09/09/10 SetReceiveThreadPriority() 廃止、 GetReceiveThreadStatusGet() 追加。
10/03/19 ReferThreadStatus() 追加。
10/08/05 ITester 廃止。
11/06/14 GetReportID() メソッドの戻り値変更。

TnbSocket.h840 行目に定義があります。

構築子と解体子

◆ CSocketClient()

CSocketClient ( bool  isAutoReconnect = true)
explicit

コンストラクタ

引数
isAutoReconnect自動接続モード。 false なら切断したら、切断のままになります。 省略か true なら切断しても自動的にリトライします。

TnbSocket.h851 行目に定義があります。

◆ ~CSocketClient()

virtual ~CSocketClient ( void  )
virtual

デストラクタ

TnbSocket.h858 行目に定義があります。

関数詳解

◆ Connect()

bool Connect ( const CSocketAddress address)

[実行] 開始

覚え書き
SetServer()Start() を実行しています。
引数
addressIPアドレス&ポートNO
戻り値
true成功。ただし自動接続モードの場合、現状コネクトしていない可能性有り。
falseコネクト失敗。自動接続モードの場合、スレッドの起動にも失敗している場合。

TnbSocket.h957 行目に定義があります。

◆ DisableReportViewer()

void DisableReportViewer ( void  )
inherited

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

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

TnbAbstractReport.h150 行目に定義があります。

◆ Disconnect()

void Disconnect ( void  )

[実行] 切断

TnbSocket.h1013 行目に定義があります。

◆ GetIdleInterval()

int GetIdleInterval ( void  ) const
inherited

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

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

TnbAbstractReport.h107 行目に定義があります。

◆ GetInterfaceId()

virtual DWORD GetInterfaceId ( void  ) const
virtualinherited

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

戻り値
ID

IReportを実装しています。

TnbAbstractReport.h78 行目に定義があります。

◆ GetMyAddress()

static CDwordVector GetMyAddress ( void  )
staticinherited

[取得] 自IPアドレス取得.

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

戻り値
自分のIPアドレス

TnbSocket.h520 行目に定義があります。

◆ GetReportID()

virtual DWORD GetReportID ( void  ) const
virtual

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

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

覚え書き
開発用のメソッドです。
戻り値
ID

IReportを実装しています。

TnbSocket.h891 行目に定義があります。

◆ GetReportName()

virtual CStr GetReportName ( void  ) const
virtual

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

覚え書き
開発用のメソッドです。
戻り値
名前

IReportを実装しています。

TnbSocket.h880 行目に定義があります。

◆ GetSocket()

SOCKET GetSocket ( void  ) const

[取得] ソケット取得

戻り値
INVALID_SOCKET接続していない
INVALID_SOCKET以外ソケット

TnbSocket.h901 行目に定義があります。

◆ IsAlive()

virtual bool IsAlive ( void  ) const
virtual

[確認] Aliveチェック.

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

戻り値
true開始している。
false停止している。

IReportを実装しています。

TnbSocket.h969 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void  ) const
virtual

[確認] 接続確認

戻り値
true接続中
false切断中

IReportを実装しています。

TnbSocket.h979 行目に定義があります。

◆ Lock()

virtual bool Lock ( DWORD  dwTime = INFINITE) const
virtualinherited

[排他] ロック

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

ISynchronizedを実装しています。

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

TnbSync.h148 行目に定義があります。

◆ m_OnEvent()

bool m_OnEvent ( const CReportEvent ev)
protectedinherited

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

引数
ev通知する内容
戻り値
true正常
false切断要求

TnbAbstractReport.h178 行目に定義があります。

◆ m_OnSend()

void m_OnSend ( size_t  sizeData,
LPCVOID  lpcvData 
)
protectedinherited

[内部] 送信情報通知

覚え書き
処理は開発用TRACEのみ
引数
sizeData送信するデータ長。
lpcvData送信するデータ。

TnbAbstractReport.h163 行目に定義があります。

◆ Purge()

virtual void Purge ( void  )
virtualinherited

[設定] パージ.

通信のゴミを浄化

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

IReportを実装しています。

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

TnbAbstractReport.h117 行目に定義があります。

◆ ReferThreadStatus()

CThreadStatus & ReferThreadStatus ( void  )

[設定] 受信スレッド状態種取得.

戻り値
スレッド状態の参照.

TnbSocket.h1022 行目に定義があります。

◆ Send()

virtual bool Send ( size_t  dataSize,
LPCVOID  lpcvData 
)
virtual

[実行] 送信

引数
dataSizeデータサイズ
lpcvDataデータ
戻り値
true成功
false失敗

IReportを実装しています。

TnbSocket.h991 行目に定義があります。

◆ SetDelayMode()

void SetDelayMode ( bool  boIsDelay)

[設定] 送信遅延モード設定

覚え書き
接続する前に設定する必要があります。
デフォルトでは遅延送信モードです。
引数
boIsDelaytrueなら遅延送信。falseなら即送信。

TnbSocket.h870 行目に定義があります。

◆ SetIdleEventMode()

virtual void SetIdleEventMode ( int  iInterval = 0)
virtualinherited

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

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

IReportを実装しています。

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

TnbAbstractReport.h90 行目に定義があります。

◆ SetListener()

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

[登録] 共通 Listner 登録.

覚え書き
登録できる IReport::IListener は一つだけです。
引数
piCommListenerリスナー。省略すると解除になります。

IReportを実装しています。

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

TnbAbstractReport.h69 行目に定義があります。

◆ SetServer()

void SetServer ( const CSocketAddress address)

[設定] サーバ設定

引数
addressIPアドレス&ポートNo

TnbSocket.h910 行目に定義があります。

◆ SetSocketListener()

virtual void SetSocketListener ( IListener piSocketListener)
virtualinherited

[設定] リスナー登録

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

TnbSocket.h466 行目に定義があります。

◆ Start()

virtual bool Start ( void  )
virtual

[実行] 開始

覚え書き
先に SetServer() でサーバの設定を行う必要があります。
戻り値
true成功。ただし自動接続モードの場合、現状コネクトしていない可能性有り。
falseコネクト失敗。自動接続モードの場合、スレッドの起動にも失敗している場合。

IReportを実装しています。

TnbSocket.h924 行目に定義があります。

◆ StartUp()

static void StartUp ( void  )
staticinherited

[設定] SOCKET初期化.

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

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

TnbSocket.h478 行目に定義があります。

◆ Stop()

virtual void Stop ( void  )
virtual

[実行] 切断

IReportを実装しています。

TnbSocket.h1001 行目に定義があります。

◆ ToViewer() [1/2]

void ToViewer ( LPCTSTR  lpszText)
protectedinherited

[出力] 文字列出力.

引数
lpszText文字列.

TnbAbstractReport.h219 行目に定義があります。

◆ ToViewer() [2/2]

void ToViewer ( size_t  sizeData,
LPCVOID  lpcvData 
)
protectedinherited

[出力] ダンプ出力.

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

TnbAbstractReport.h210 行目に定義があります。

◆ Unlock()

virtual void Unlock ( void  ) const
virtualinherited

[排他] アンロック

ISynchronizedを実装しています。

TnbSync.h155 行目に定義があります。

◆ WaitConnect()

bool WaitConnect ( DWORD  dwTime) const
inherited

[確認] 接続待ち

引数
dwTime待ち時間(ms)
戻り値
true接続
falseタイムアウト

TnbAbstractReport.h127 行目に定義があります。