SocketUPDクラス [詳解]

#include <TnbSocketUdp.h>

CSocketUdp の継承関係図

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

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

const CSocketAddress &	GetAddressee (void) const
	[取得] 送信先アドレス取得. [詳解]

const CSocketAddress &	GetBaseAddress (void) const
	[取得] ベースアドレス取得. [詳解]

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

virtual DWORD	GetInterfaceId (void) const
	[取得] インターフェースID取得 [詳解]

WORD	GetMaxDatagram (void)
	[取得] UDP送信最大サイズ取得. [詳解]

size_t	GetReceivedBufferSize (void) const
	[取得] 受信バッファサイズ取得. [詳解]

CThreadStatus &	GetReceiveThreadStatus (void)
	[参照] 受信スレッド状態参照. [詳解]

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)
	[設定] パージ. [詳解]

CThreadStatus &	ReferThreadStatus (void)
	[参照] 受信スレッド状態参照. [詳解]

virtual bool	Send (size_t dataSize, LPCVOID lpcvData)
	[実行] 送信 [詳解]

bool	SetAddressee (const CSocketAddress &address)
	[設定] 送信先アドレス指定 [詳解]

void	SetBaseAddress (const CSocketAddress &address)
	[設定] ベースアドレス設定. [詳解]

void	SetBroadcastPort (WORD portNo, DWORD address=INADDR_BROADCAST)
	[設定] ブロードバンド送信指定 [詳解]

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

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

bool	SetReceivedBufferSize (size_t size)
	[設定] 受信バッファサイズ設定. [詳解]

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

virtual bool	Start (void)
	[実行] 開始 [詳解]

virtual void	Stop (void)
	[実行] 切断 [詳解]

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

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

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

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

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

static bool	WakeupOnLan (const BYTE *pbMacAddr)
	[送信] Wake up on LAN [詳解]

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

詳解

SocketUPDクラス

UDPソケットを用意します。

受信は CAbstractSocket::IListener か IReport::IListener の実装クラスを作成し SetSocketListener() , SetListener() を使い登録します。
両方登録している場合、受信時、先に CAbstractSocket::IListener に通知されます。

覚え書き: 送信サイズごとに受信されます( TCP と異なり、連結されることはありません )。; ReportEvent_Connect イベントは、Start 時、 ReportEvent_Disconnect イベントは、Stop直前に通知されます。; リスナー内で SendMessage を使う場合、 ReferThreadStatus() で関連ウィンドウを指定する必要があります。 CThread::SetOwnerHwnd() を参照してください。

必要ファイル: TnbSocketUdp.h

日付: 06/07/06 新規作成; 06/08/31 CommViewer に対応。; 06/09/09 IsAlive() / IsConnect() 追加。 CanAccess() 廃止。 ECE_Connect , ECE_Disconnect イベント、追加。; 06/10/24 Magicpacket対応。; 07/06/11 親クラスの Start() メソッドに対応。; 09/07/31 ECE_Idle イベントに対応。; 09/08/27 SetReceiveThreadPriority() 追加。構成変更。IsAlive() の戻り値修正。 GetIdleInterval() が0の時、 select せずに recv するようにした（速度を稼ぐため）; 09/09/04 GetReceivedBufferSize(), SetReceivedBufferSize() 追加。; 09/09/10 SetReceiveThreadPriority() 廃止、 GetReceiveThreadStatusGet() 追加。; 10/03/19 ReferThreadStatus() 追加。; 10/08/05 ITester 廃止。; 11/06/14 GetReportID() メソッドの戻り値変更。; 12/03/30 大幅改修。

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

構築子と解体子

◆ CSocketUdp()

CSocketUdp ( void )

コンストラクタ

TnbSocketUdp.h の 68 行目に定義があります。

◆ ~CSocketUdp()

virtual ~CSocketUdp ( void )

virtual

デストラクタ

TnbSocketUdp.h の 75 行目に定義があります。

関数詳解

◆ DisableReportViewer()

void DisableReportViewer ( void )

inherited

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

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

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

◆ GetAddressee()

const CSocketAddress & GetAddressee ( void ) const

[取得] 送信先アドレス取得.

SetAddressee() か SetBroadcastPort() で設定したアドレスが得られます。

戻り値: アドレス

TnbSocketUdp.h の 225 行目に定義があります。

◆ GetBaseAddress()

const CSocketAddress & GetBaseAddress ( void ) const

[取得] ベースアドレス取得.

戻り値: 受信に使用するアドレス

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

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

◆ GetMaxDatagram()

WORD GetMaxDatagram ( void )

[取得] UDP送信最大サイズ取得.

注意: 本メソッドの値に関わらず、ネットワークの MTU (Maximum Transmission Unit) を超えるブロードキャストデータグラムの送信はお薦めできません。

戻り値: サイズ

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

◆ GetMyAddress()

static CDwordVector GetMyAddress ( void )

staticinherited

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

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

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

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

◆ GetReceivedBufferSize()

size_t GetReceivedBufferSize ( void ) const

[取得] 受信バッファサイズ取得.

戻り値

0	取得失敗。 Start していない、など。
1以上	取得成功。値は、バッファサイズ。

TnbSocketUdp.h の 311 行目に定義があります。

◆ GetReceiveThreadStatus()

CThreadStatus & GetReceiveThreadStatus ( void )

[参照] 受信スレッド状態参照.

覚え書き: 旧メソッド名です。 ReferThreadStatus() を使ってください。

戻り値

スレッド状態の参照.

TnbSocketUdp.h の 301 行目に定義があります。

◆ GetReportID()

virtual DWORD GetReportID ( void ) const

virtual

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

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

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

戻り値: ID

IReportを実装しています。

TnbSocketUdp.h の 96 行目に定義があります。

◆ GetReportName()

virtual CStr GetReportName ( void ) const

virtual

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

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

戻り値: 名前

IReportを実装しています。

TnbSocketUdp.h の 85 行目に定義があります。

◆ GetSocket()

SOCKET GetSocket ( void ) const

[取得] ソケット取得

戻り値

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

TnbSocketUdp.h の 106 行目に定義があります。

◆ IsAlive()

virtual bool IsAlive ( void ) const

virtual

[確認] Aliveチェック.

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

戻り値

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

IReportを実装しています。

TnbSocketUdp.h の 204 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void ) const

virtual

[確認] 接続チェック.

覚え書き: 本クラスの場合、Start() が成功していたら接続中扱いにしています。

戻り値

true	接続中。
false	切断。

IReportを実装しています。

TnbSocketUdp.h の 215 行目に定義があります。

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

◆ ReferThreadStatus()

CThreadStatus & ReferThreadStatus ( void )

[参照] 受信スレッド状態参照.

戻り値

スレッド状態の参照.

TnbSocketUdp.h の 291 行目に定義があります。

◆ Send()

virtual bool Send	(	size_t	dataSize,
		LPCVOID	lpcvData
	)

virtual

[実行] 送信

覚え書き: 本メソッドを使う前に、一度 SetAddressee() か SetBroadcastPort() で送信先を設定する必要があります。

引数

dataSize	データサイズ
lpcvData	データ

戻り値

true	成功
false	失敗

IReportを実装しています。

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

TnbSocketUdp.h の 266 行目に定義があります。

◆ SetAddressee()

bool SetAddressee ( const CSocketAddress & address )

[設定] 送信先アドレス指定

覚え書き: Start() の後、 Send() 前に本メソッドで送信先を設定する必要があります。

引数

address 相手のIPアドレス&ポートNo

戻り値

true	成功。
false	失敗(名前が解決できない)

TnbSocketUdp.h の 237 行目に定義があります。

◆ SetBaseAddress()

void SetBaseAddress ( const CSocketAddress & address )

[設定] ベースアドレス設定.

受信に使用する IP アドレス(INADDR_ANY でも可)、ポートNo を指定します。ポートNo は UDP ヘッダの送信元ポートNoにも使われます。

注意: Start() 前に使用してください。

覚え書き: ポートNo に０を指定すると送信専用になります（受信 Event は発生しません)。

引数

address アドレス

TnbSocketUdp.h の 135 行目に定義があります。

◆ SetBroadcastPort()

void SetBroadcastPort	(	WORD	portNo,
		DWORD	address = `INADDR_BROADCAST`
	)

[設定] ブロードバンド送信指定

覚え書き: Start() の後、 Send() 前に本メソッドで送信先を設定する必要があります。

引数

portNo	送信先ポートNo
address	アドレス。省略すると INADDR_BROADCAST

TnbSocketUdp.h の 250 行目に定義があります。

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

◆ SetReceivedBufferSize()

bool SetReceivedBufferSize ( size_t size )

[設定] 受信バッファサイズ設定.

引数

size 受信バッファサイズ

戻り値

true	成功。
false	失敗。 Start していない、など。

TnbSocketUdp.h の 325 行目に定義があります。

◆ SetSocketListener()

virtual void SetSocketListener ( IListener * piSocketListener )

virtualinherited

[設定] リスナー登録

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

引数

piSocketListener リスナー

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

◆ Start()

virtual bool Start ( void )

virtual

[実行] 開始

覚え書き: SetBaseAddress() で設定後、本メソッドを使用します。

戻り値

true	成功。送受信可能。
false	失敗。

IReportを実装しています。

TnbSocketUdp.h の 157 行目に定義があります。

◆ StartUp()

static void StartUp ( void )

staticinherited

[設定] SOCKET初期化.

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

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

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

◆ Stop()

virtual void Stop ( void )

virtual

[実行] 切断

IReportを実装しています。

TnbSocketUdp.h の 275 行目に定義があります。

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

◆ WakeupOnLan()

static bool WakeupOnLan ( const BYTE * pbMacAddr )

static

[送信] Wake up on LAN

引数

pbMacAddr 6BYTEのMACアドレス。

戻り値

true	成功。
false	失敗。

TnbSocketUdp.h の 345 行目に定義があります。

公開メンバ関数

静的公開メンバ関数

限定公開メンバ関数

詳解

構築子と解体子

◆ CSocketUdp()

◆ ~CSocketUdp()

関数詳解

◆ DisableReportViewer()

◆ GetAddressee()

◆ GetBaseAddress()

◆ GetIdleInterval()

◆ GetInterfaceId()

◆ GetMaxDatagram()

◆ GetMyAddress()

◆ GetReceivedBufferSize()

◆ GetReceiveThreadStatus()

◆ GetReportID()

◆ GetReportName()

◆ GetSocket()

◆ IsAlive()

◆ IsConnect()

◆ Lock()

◆ m_OnEvent()

◆ m_OnSend()

◆ Purge()

◆ ReferThreadStatus()

◆ Send()

◆ SetAddressee()

◆ SetBaseAddress()

◆ SetBroadcastPort()

◆ SetIdleEventMode()

◆ SetListener()

◆ SetReceivedBufferSize()

◆ SetSocketListener()

◆ Start()

◆ StartUp()

◆ Stop()

◆ ToViewer() [1/2]

◆ ToViewer() [2/2]

◆ Unlock()

◆ WaitConnect()

◆ WakeupOnLan()