前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXStreamReader
読み込み用ストリームにアクセスするためのクラスです。
#include <SFXStreamReader.h.hpp>
class SFXStreamReader : public SFXInputStream;
SFMTYPEDEFCLASS(SFXStreamReader)

継承図

SFXStreamReader クラスの継承図

協調図

SFXStreamReader クラスの協調図

解説

SFXStreamReader クラスは、 ストレージのストリームからデータを読み込むときに使います。

読み込むデータの種類に応じて、 SFXStreamReader クラスを継承する SFXBinaryStreamReader / SFXAnsiStringStreamReader / SFXWideStringStreamReader クラスのいずれかを使います。

可変長バッファストリームの場合は、 内部で SFXElasticStreamReader クラスが利用されますが、 開発者はこれについて意識する必要はありません。

参照

SFXBinaryStreamReader | SFXAnsiStringStreamReader | SFXWideStringStreamReader | SFXElasticStreamReader | SFXStreamWriter | ストリーム | ストレージ

メンバ

コンストラクタ/デストラクタ
SFXStreamReader( Void )
SFXStreamReader クラスのコンストラクタです。
パブリック関数
Void Attach( SFXInputStreamPtr stream )
このストリームに指定されたストリームを結び付けます。
Void Cancel( Void )
ストリームからの読み込みをキャンセルします。
SFXInputStreamPtr Detach( Void )
このストリームに結び付けられているストリームを切り離します。
Bool Ends( Void )
読み込みポインタがストリームの終端に到達したか判定します。
SFCError Fetch( Void )
ストレージからストリームにデータを読み込みます。
SFCError Fetch( CallbackSPP spp , VoidPtr reference )
ストレージからストリームにデータを読み込みます。
SInt32 FirstIndexOf( Byte byte , SInt32 index = SINT32_MINIMUM )
ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
SInt32 FirstIndexOf( SFXBufferConstRef buffer , SInt32 index = SINT32_MINIMUM )
ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
SInt32 FirstIndexOf( VoidConstPtr buffer , UInt32 size , SInt32 index = SINT32_MINIMUM )
ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
UInt32 GetReadableSize( Void )
ストリームから読み込み可能なデータサイズを取得します。[単位: バイト]
SInt32 LastIndexOf( Byte byte , SInt32 index = SINT32_MAXIMUM )
ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
SInt32 LastIndexOf( SFXBufferConstRef buffer , SInt32 index = SINT32_MAXIMUM )
ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
SInt32 LastIndexOf( VoidConstPtr buffer , UInt32 size , SInt32 index = SINT32_MAXIMUM )
ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
SFCError Read( SFXBufferPtr buffer )
ストリームからデータを読み込みます。
SFCError Read( VoidPtr buffer , UInt32 size )
ストリームからデータを読み込みます。
Void Release( Void )
ストリームを解放します。
SFCError ResetTrigger( Void )
トリガー(コールバック関数が呼ばれるタイミング)をリセットします。
SFCError Seek( UInt32 size )
読み込みポインタを進めます。
SFCError SetTrigger( UInt32 size )
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
SFCError SetTrigger( SFXBufferConstRef buffer )
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
SFCError SetTrigger( VoidConstPtr buffer , UInt32 size )
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
Bool Triggers( Void )
トリガーによりコールバック関数が呼び出されたか判定します。
型
CallbackSPP (SFXStream から継承)
コールバック関数を表す型です。
SFXStreamReader::SFXStreamReader
SFXStreamReader クラスのコンストラクタです。
[ public, explicit ]
SFXStreamReader(Void);

解説

特に何も行いません。

SFXStreamReader::Attach
このストリームに指定されたストリームを結び付けます。
[ public ]
Void Attach(
    SFXInputStreamPtr stream   // 設定するストリーム
);

解説

この関数は、このストリームに指定されたストリームを結び付けます。

この関数を呼び出す前にこのストリームに設定されていたストリームは破棄されます。

参照

SFXStreamReader::Detach

SFXStreamReader::Cancel
ストリームからの読み込みをキャンセルします。
[ public, virtual ]
Void Cancel(Void);

解説

この関数は、 このストリームからの読み込みをキャンセルします。

具体的には、下記の処理を内部で行います。

  1. このストリームに関連付けられたストレージの Cancel 関数を呼び出します。

    ファイルの場合は SFXFile::Cancel 関数を、 TCP ソケットの場合は SFXTCPSocket::Cancel 関数を呼び出します。

  2. SFXStreamReader::Fetch 関数による、 このストリームについてのコールバック関数の登録をキャンセルします。

[Note] 注意
この関数は、内部的に SFXStreamReader::Release 関数から呼び出されます。

参照

SFXStreamReader::Release | SFXStreamReader::Fetch | SFXFile::Cancel | SFXTCPSocket::Cancel

SFXStreamReader::Detach
このストリームに結び付けられているストリームを切り離します。
[ public ]
SFXInputStreamPtr Detach(Void);

戻り値

このストリームに結び付けられていたストリーム

解説

この関数を呼び出した後、 このストリームにはストリームが設定されていない状態になります。

参照

SFXStreamReader::Attach

SFXStreamReader::Ends
読み込みポインタがストリームの終端に到達したか判定します。
[ public, virtual, const ]
Bool Ends(Void);

戻り値

  • 読み込みポインタがストリームバッファの終端に到達し、ストレージから読み込むデータがないとき: true
  • そうでないとき: false

解説

この関数は、読み込みポインタがストリームの終端に到達したか判定します。

もし読み込みポインタがストリームバッファの終端に到達し、 このストリームに設定されたストレージからデータが読み込めないときは、"true" が返ります。 そうでない場合は、"false" が返ります。

参照

SFXStreamReader::Fetch | ストリームバッファ | ストレージ

SFXStreamReader::Fetch
ストレージからストリームにデータを読み込みます。
[ public, virtual ]
SFCError Fetch(Void);
[ public, virtual ]
SFCError Fetch(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数に渡すデータ（参照値）
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ストリームが設定されていない、 または 既にこの関数を呼び出してコールバックを待っているとき: SFERR_INVALID_STATE
  • 失敗したとき: SFERR_FAILED または AEEError.h で定義されるエラー値

解説

この関数は、 ストリームに関連付けられたストレージから ストリームバッファにデータを読み込みます。

この関数には、コールバック関数を登録するタイプと登録しないタイプがあります。 利用可能なタイプはストレージの種類に依存します。

例えば、SFXTCPSocket クラスから得られるストリームでは、 コールバック関数を登録するタイプだけが利用可能です。 一方、SFXFile クラスから得られるストリームでは、 両方のタイプが使用できます。

コールバック関数を登録する場合、 ストレージから内部バッファへのデータ読み込みが完了したタイミングでコールバック関数が呼び出されます。 データ読み込み時のエラーは、コールバック関数の第 1 引数に渡されます。 なお、この関数の戻り値がエラー（SFERR_NO_ERROR 以外の値）の場合、コールバック関数は呼び出されません。

コールバック関数を登録しない場合は、 この関数を呼び出すと、ストレージから内部バッファにデータはすぐに読み込まれます。

[Tip] Tip
SFXStreamReader::Read 関数を呼び出すことにより、 ストリームバッファ内のデータを読み込みます。

参照

SFXStreamReader::SetTrigger | SFXStreamReader::Read | ストレージ | ストリームバッファ

SFXStreamReader::FirstIndexOf
ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
[ public, virtual, const ]
SInt32 FirstIndexOf(
    Byte byte                       // 検索するデータ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);
[ public, virtual, const ]
SInt32 FirstIndexOf(
    SFXBufferConstRef buffer        // 検索するデータ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);
[ public, virtual, const ]
SInt32 FirstIndexOf(
    VoidConstPtr buffer             // 検索するデータ
    UInt32 size                     // 検索するデータのサイズ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

戻り値

  • 成功したとき: 見つかった位置のインデックス
  • 失敗したとき: -1

解説

この関数は、 ストリームバッファを先頭から検索して、 指定したデータと一致する最初のインデックスを取得します。

検索開始位置を指定することで、先頭以外の位置から検索できます。

[Note] 注意
ストリームバッファの先頭インデックスは 0 です。

参照

SFXStreamReader::LastIndexOf | ストリームバッファ

SFXStreamReader::GetReadableSize
ストリームから読み込み可能なデータサイズを取得します。[単位: バイト]
[ public, virtual, const ]
UInt32 GetReadableSize(Void);

戻り値

ストリームバッファから読み込み可能なデータサイズ [単位: バイト]

解説

この関数は、ストリームバッファから読み込み可能なデータサイズを取得します。[単位: バイト]

[Note] 注意
バッファの物理的なサイズは、ストレージクラスの GetStreamReader 関数の size 引数に指定します。
[Tip] Tip
読み込むデータサイズが不明の場合、 SFXStreamReader::Read 関数を呼び出す前に この関数を呼び出して読み込み可能なデータサイズを調べる必要があります。

参照

SFXStreamReader::Read | SFXStreamReader::Fetch | ストリームバッファ | ストレージ

SFXStreamReader::LastIndexOf
ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
[ public, virtual, const ]
SInt32 LastIndexOf(
    Byte byte                       // 検索するデータ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);
[ public, virtual, const ]
SInt32 LastIndexOf(
    SFXBufferConstRef buffer        // 検索するデータ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);
[ public, virtual, const ]
SInt32 LastIndexOf(
    VoidConstPtr buffer             // 検索するデータ
    UInt32 size                     // 検索するデータのサイズ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

戻り値

  • 成功したとき: 見つかった位置のインデックス
  • 失敗したとき: -1

解説

この関数は、 ストリームバッファを終端から検索して、 指定したデータと一致する最後のインデックスを取得します。

検索開始位置を指定することで、終端以外の位置から検索できます。

[Note] 注意
ストリームバッファの先頭インデックスは 0 です。

参照

SFXStreamReader::FirstIndexOf | ストリームバッファ

SFXStreamReader::Read
ストリームからデータを読み込みます。
[ public, virtual ]
SFCError Read(
    SFXBufferPtr buffer   // 読み込む変数
);
[ public, virtual ]
SFCError Read(
    VoidPtr buffer   // 読み込む変数
    UInt32 size      // 読み込む変数のサイズ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ストリームが設定されていないとき: SFERR_INVALID_STATE
  • ストリームバッファと buffer 引数のメモリが共通部分を持つとき: SFERR_INVALID_PARAM
  • buffer 引数が null、size 引数が 0 以下、または buffer 引数(size 引数)のサイズが SFXStreamReader::GetReadableSize 関数の戻り値よりも大きいとき: SFERR_FAILED

解説

この関数は、 ストリームバッファ内のデータを指定した変数に読み込みます。

読み込み可能なデータサイズは SFXStreamReader::GetReadableSize 関数で取得できます。

[Note] 注意
ストリームバッファの物理的サイズは、ストレージクラスの GetStreamReader 関数の size 引数に指定します。
[Caution] 注意

SFXBuffer 型の buffer 引数を使用するときは、 この関数を呼び出す前に SFXBuffer::SetSize 関数を使用してこのストリームから読み込むデータのサイズを設定する必要があります。

buffer 引数が null、size 引数が 0 以下、または buffer 引数(size 引数)のサイズが SFXStreamReader::GetReadableSize 関数の戻り値よりも大きい場合は、 SFERR_FAILED を返します。

ストリームバッファが buffer 引数のメモリ領域の一部を含む場合は、 SFERR_INVALID_PARAM を返します。

[Tip] Tip
SFXStreamReader::Fetch 関数を呼び出すことにより、 ストリームに関連付けられたストレージからストリームバッファにデータを読み込みます。

参照

SFXStreamReader::GetReadableSize | SFXStreamReader::Fetch | ストリームバッファ | ストレージ

SFXStreamReader::Release
ストリームを解放します。
[ public ]
Void Release(Void);

解説

この関数は、 このストリームからの読み込みをキャンセルし、ストリームを解放します。

[Note] 注意

この関数は、ストリームのデストラクタから呼び出されます。

また、SFXStreamReader::Cancel 関数を呼び出して、 このストリームからの読み込みをキャンセルします。

参照

SFXStreamReader::Cancel

SFXStreamReader::ResetTrigger
トリガー(コールバック関数が呼ばれるタイミング)をリセットします。
[ public, virtual ]
SFCError ResetTrigger(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ストリームが設定されていない、 または 既に SFXStreamReader::Fetch 関数を呼び出してコールバックを待っているとき: SFERR_INVALID_STATE

解説

この関数は、 SFXStreamReader::SetTrigger 関数で設定したトリガー(コールバック関数が呼ばれるタイミング)をリセットします。

参照

SFXStreamReader::SetTrigger | SFXStreamReader::Triggers | SFXStreamReader::Fetch

SFXStreamReader::Seek
読み込みポインタを進めます。
[ public, virtual ]
SFCError Seek(
    UInt32 size   // 進めるサイズ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ストリームが設定されていないとき: SFERR_INVALID_STATE
  • 読み込みポインタがストリームバッファの終端を越えたとき: SFERR_FAILED

解説

この関数は、 ストリームバッファからデータを読み込むための読み込みポインタを進めます。

参照

ストリームバッファ

SFXStreamReader::SetTrigger
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
[ public, virtual ]
SFCError SetTrigger(
    UInt32 size   // トリガーとなるサイズ
);
[ public, virtual ]
SFCError SetTrigger(
    SFXBufferConstRef buffer   // トリガーとなるデータ
);
[ public, virtual ]
SFCError SetTrigger(
    VoidConstPtr buffer   // トリガーとなるデータ
    UInt32 size           // トリガーとなるデータのサイズ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ストリームが設定されていない、 または SFXStreamReader::Fetch 関数によりコールバック関数が登録された状態であるとき: SFERR_INVALID_STATE
  • メモリ不足のとき: SFERR_NO_MEMORY

解説

SFXStreamReader::Fetch 関数で登録されたコールバック関数は、 ストリームバッファが読み込んだデータで一杯になったときや、 このストリームに設定されたストレージの終端までデータを読み込んだときに呼び出されます。

この関数は、これら以外のタイミングでコールバック関数を呼び出すためのトリガーを設定します。

size 引数だけを指定した場合は、 そのサイズのデータを読み込む毎にコールバック関数が呼び出されます。

buffer 引数を指定した場合は、 それと同じデータを読み込む毎にコールバック関数が呼び出されます。

使用例

改行文字を読み込む毎にコールバック関数を呼び出す方法は、以下の通りです。 

SetTrigger("\r\n", 2);

参照

SFXStreamReader::ResetTrigger | SFXStreamReader::Triggers | SFXStreamReader::Fetch

SFXStreamReader::Triggers
トリガーによりコールバック関数が呼び出されたか判定します。
[ public, virtual, const ]
Bool Triggers(Void);

戻り値

  • SFXStreamReader::SetTrigger 関数で設定したトリガーによって、コールバック関数が呼び出されたとき: true
  • そうでないとき: false

解説

この関数は、 SFXStreamReader::SetTrigger 関数で設定したトリガーによって、 コールバック関数が呼び出されたか判定します。

[Tip] Tip
SFXStreamReader::Fetch 関数で登録したコールバック関数の中で使います。

参照

SFXStreamReader::SetTrigger | SFXStreamReader::ResetTrigger | SFXStreamReader::Fetch

Copyright(c) 2002 - 2024
Sophia Cradle Incorporated
All Rights Reserved. 		前のページ次のページ上に戻るホーム