alt::RingBuffer クラス

リングバッファに関するクラス [詳解]

#include <RingBuffer.h>

alt::RingBuffer の継承関係図

公開メンバ関数
APIENTRY	RingBuffer ()
	コンストラクタ
APIENTRY	RingBuffer (SIZE_T size)
	コンストラクタ
APIENTRY	~RingBuffer ()
	デストラクタ
BOOL APIENTRY	Clear ()
	バッファのクリア
BOOL APIENTRY	Init (SIZE_T size)
	初期化
BOOL APIENTRY	Read (LPBYTE lpbyBuffer, SIZE_T size)
	バッファの読み込み
SIZE_T APIENTRY	Remain () const
	残りバッファサイズの取得
BOOL APIENTRY	Write (LPBYTE lpbyBuffer, SIZE_T size)
	バッファの書き込み
基底クラス alt::WindowsLibrary に属する継承公開メンバ関数
APIENTRY	WindowsLibrary ()
	コンストラクタ
virtual APIENTRY	~WindowsLibrary ()
	デストラクタ
virtual DWORD APIENTRY	GetErrNo () const
	WindowsAPIのエラー値を取得します。
virtual VOID APIENTRY	SetErrNo ()
	WINAPIエラーの情報を設定します。

非公開変数類
LPBYTE	_lpbyEndPoint
LPBYTE	_lpbyReadPoint
LPBYTE	_lpbyStartPoint
LPBYTE	_lpbyWritePoint
SIZE_T	_remainSize
SIZE_T	_size

その他の継承メンバ
基底クラス alt::WindowsLibrary に属する継承限定公開変数類
DWORD	_dwErrorNo

詳解

リングバッファに関するクラス

RingBuffer.h の 15 行目に定義があります。

構築子と解体子

RingBuffer() [1/2]

RingBuffer::RingBuffer

(

)

コンストラクタ

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

参照先 _lpbyEndPoint, _lpbyReadPoint, _lpbyStartPoint, _lpbyWritePoint, _remainSize, _size.

RingBuffer() [2/2]

RingBuffer::RingBuffer

(

SIZE_T

size

)

コンストラクタ

引数

size

バッファサイズ

RingBuffer.cpp の 23 行目に定義があります。

参照先 Init().

~RingBuffer()

RingBuffer::~RingBuffer

(

)

デストラクタ

RingBuffer.cpp の 29 行目に定義があります。

参照先 _lpbyStartPoint.

関数詳解

Clear()

BOOL RingBuffer::Clear

(

)

バッファのクリア

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

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

参照先 _lpbyEndPoint, _lpbyReadPoint, _lpbyStartPoint, _lpbyWritePoint, _remainSize, _size.

Init()

BOOL RingBuffer::Init

(

SIZE_T

size

)

初期化

引数

size

バッファサイズ

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

RingBuffer.cpp の 35 行目に定義があります。

参照先 _lpbyEndPoint, _lpbyReadPoint, _lpbyStartPoint, _lpbyWritePoint, _remainSize, _size, size.

参照元 WindowsLibraryTest::TEST_CLASS().

Read()

BOOL RingBuffer::Read	(	LPBYTE	lpbyBuffer,
		SIZE_T	size
	)

バッファの読み込み

引数

lpbyBuffer	読み込みバッファ
size	バッファサイズ

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

RingBuffer.cpp の 89 行目に定義があります。

参照先 _lpbyEndPoint, _lpbyReadPoint, _lpbyStartPoint, _remainSize, size.

参照元 WindowsLibraryTest::TEST_CLASS().

Remain()

SIZE_T RingBuffer::Remain

(

)

const

残りバッファサイズの取得

戻り値

SIZE_T 残りバッファ数

RingBuffer.cpp の 120 行目に定義があります。

参照先 _remainSize.

参照元 WindowsLibraryTest::TEST_CLASS().

Write()

BOOL RingBuffer::Write	(	LPBYTE	lpbyBuffer,
		SIZE_T	size
	)

バッファの書き込み

引数

lpbyBuffer	書き込みバッファ
size	バッファサイズ

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

RingBuffer.cpp の 59 行目に定義があります。

参照先 _lpbyEndPoint, _lpbyStartPoint, _lpbyWritePoint, _remainSize, _size, size.

参照元 WindowsLibraryTest::TEST_CLASS().

メンバ詳解

_lpbyEndPoint

LPBYTE alt::RingBuffer::_lpbyEndPoint

private

RingBuffer.h の 63 行目に定義があります。

参照元 RingBuffer(), Clear(), Init(), Read(), Write().

_lpbyReadPoint

LPBYTE alt::RingBuffer::_lpbyReadPoint

private

RingBuffer.h の 67 行目に定義があります。

参照元 RingBuffer(), Clear(), Init(), Read().

_lpbyStartPoint

LPBYTE alt::RingBuffer::_lpbyStartPoint

private

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

参照元 RingBuffer(), ~RingBuffer(), Clear(), Init(), Read(), Write().

_lpbyWritePoint

LPBYTE alt::RingBuffer::_lpbyWritePoint

private

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

参照元 RingBuffer(), Clear(), Init(), Write().

_remainSize

SIZE_T alt::RingBuffer::_remainSize

private

RingBuffer.h の 65 行目に定義があります。

参照元 RingBuffer(), Clear(), Init(), Read(), Remain(), Write().

_size

SIZE_T alt::RingBuffer::_size

private

RingBuffer.h の 64 行目に定義があります。

参照元 RingBuffer(), Clear(), Init(), Write().

---

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

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