alt::NamedPipe クラス

名前付きパイプに関するWindowsAPIを集約したクラス [詳解]

#include <NamedPipe.h>

alt::NamedPipe の継承関係図

公開メンバ関数
BOOL APIENTRY	Connect () const
	サーバー側でクライアント接続を待機します。
BOOL APIENTRY	Create (LPCTSTR lpctszName, BOOL bStreamMode)
	パイプを作成します。
BOOL APIENTRY	Disconnect () const
	サーバー側でクライアント接続を切断します。
BOOL APIENTRY	Open (LPCTSTR lpctszName)
	パイプをオープンします。
DWORD APIENTRY	PeekData (LPVOID lpvData, DWORD dwSize) const
	メッセージ内容を取り出さずに読み取ります。
DWORD APIENTRY	PeekRemain () const
	バッファ内に残っているメッセージサイズを取得します。
BOOL APIENTRY	Wait (LPCTSTR lpctszName, DWORD dwTimeout=NMPWAIT_USE_DEFAULT_WAIT) const
	クライアント側でサーバー接続を待機します。
基底クラス alt::ReadWriteHandleLibrary に属する継承公開メンバ関数
BOOL APIENTRY	Flush () const
	まだデバイスに出力されていないデータを吐き出させます。
DWORD APIENTRY	Read (LPVOID lpvBuffer, DWORD dwSize) const
	HANDLEを使ってデータを読み込みます。
DWORD APIENTRY	Write (LPCVOID lpcvBuffer, DWORD dwSize) const
	HANDLEを使ってデータを書き込みます。
基底クラス alt::HandleLibrary に属する継承公開メンバ関数
APIENTRY	HandleLibrary ()
	コンストラクタ
APIENTRY	~HandleLibrary ()
	デストラクタ
BOOL APIENTRY	Close ()
	使用しなくなったハンドルはこれでクローズします。
HANDLE APIENTRY	GetHandle () const
	継承先はこの関数でハンドルを取得します。
基底クラス alt::WindowsLibrary に属する継承公開メンバ関数
APIENTRY	WindowsLibrary ()
	コンストラクタ
virtual APIENTRY	~WindowsLibrary ()
	デストラクタ
virtual DWORD APIENTRY	GetErrNo () const
	WindowsAPIのエラー値を取得します。
virtual VOID APIENTRY	SetErrNo ()
	WINAPIエラーの情報を設定します。

その他の継承メンバ
基底クラス alt::HandleLibrary に属する継承限定公開変数類
HANDLE	_hObject
	ハンドルを使用するWindowsAPIで保持するHANDLE値
基底クラス alt::WindowsLibrary に属する継承限定公開変数類
DWORD	_dwErrorNo

詳解

名前付きパイプに関するWindowsAPIを集約したクラス

NamedPipe.h の 17 行目に定義があります。

関数詳解

Connect()

BOOL NamedPipe::Connect

(

)

const

サーバー側でクライアント接続を待機します。

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

NamedPipe.cpp の 47 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

参照元 WindowsLibraryTest::TEST_CLASS().

Create()

BOOL NamedPipe::Create	(	LPCTSTR	lpctszName,
		BOOL	bStreamMode
	)

パイプを作成します。

引数

[in]	lpctszName	パイプ名
[in]	bStreamMode	ストリームモードがバイトモードか。

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

パイプ名は内部で正式名に補完します。

NamedPipe.cpp の 12 行目に定義があります。

参照先 alt::HandleLibrary::_hObject, PIPE_NAME_FORMAT.

参照元 WindowsLibraryTest::TEST_CLASS().

Disconnect()

BOOL NamedPipe::Disconnect

(

)

const

サーバー側でクライアント接続を切断します。

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

NamedPipe.cpp の 52 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

Open()

BOOL NamedPipe::Open

(

LPCTSTR

lpctszName

)

パイプをオープンします。

引数

[in]

lpctszName

パイプ名

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

パイプ名は内部で正式名に補完します。

NamedPipe.cpp の 57 行目に定義があります。

参照先 alt::HandleLibrary::_hObject, PIPE_NAME_FORMAT.

参照元 WindowsLibraryTest::TEST_CLASS().

PeekData()

DWORD NamedPipe::PeekData	(	LPVOID	lpvData,
		DWORD	dwSize
	)		const

メッセージ内容を取り出さずに読み取ります。

引数

[in]	lpvData	読み取りバッファ
[in]	dwSize	読み取りバッファサイズ

戻り値

DWORD

戻り値

読み取りバイトサイズ(成功)
-1(失敗)

NamedPipe.cpp の 84 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

参照元 WindowsLibraryTest::TEST_CLASS().

PeekRemain()

DWORD NamedPipe::PeekRemain

(

)

const

バッファ内に残っているメッセージサイズを取得します。

戻り値

DWORD

戻り値

読み取りバイトサイズ(成功)
-1(失敗)

NamedPipe.cpp の 95 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

参照元 WindowsLibraryTest::TEST_CLASS().

Wait()

BOOL NamedPipe::Wait	(	LPCTSTR	lpctszName,
		DWORD	dwTimeout = NMPWAIT_USE_DEFAULT_WAIT
	)		const

クライアント側でサーバー接続を待機します。

引数

[in]	lpctszName	パイプ名
[in]	dwTimeout	タイムアウト時間(ミリ秒)

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

NamedPipe.cpp の 75 行目に定義があります。

参照先 PIPE_NAME_FORMAT.

参照元 WindowsLibraryTest::TEST_CLASS().

---

このクラス詳解は次のファイルから抽出されました:

• C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/NamedPipe.h
• C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/NamedPipe.cpp