SFXStorage

ストレージを表す基底クラスです。

#include <SFXStorage.h.hpp>

class SFXStorage;

SFMTYPEDEFCLASS(SFXStorage)

継承図

解説

メモリ、ファイルやネットワークなど、読み書きの対象を抽象化したクラスです。ストレージクラスに対しては、入出力ストリームが利用可能です。

SFXStorage クラスを継承するクラスは、SFXFile、SFXTCPSocket、SFXSSLSocket、SFXMemory、SFXSource、 SFXZIPDecoder の 6 種類です。

参照

メンバ

コンストラクタ/デストラクタ
SFXStorage( `Void` ) SFXStorage クラスのコンストラクタです。
~SFXStorage( `Void` ) SFXStorage クラスのデストラクタです。

パブリック関数
`SFCError`	AsSFBAStream( `SFBAStreamSmpPtr` result ) 内部で管理されているストレージのインスタンスを SFBAStream クラスのインスタンスに変換します。
`SFCError`	AsSFBSource( `SFBSourceSmpPtr` result ) 内部で管理されているストレージのインスタンスを SFBSource クラスのインスタンスに変換します。
`Void`	Cancel( `Void` ) データの読み書きをキャンセルします。
`SFCError`	GetStreamReader( `UInt32` size , `SFXStreamReaderPtr` result ) GetStreamReader( `SFXStreamReaderPtr` result ) 読み込み用ストリームを取得します。
`SFCError`	GetStreamWriter( `UInt32` size , `SFXStreamWriterPtr` result ) GetStreamWriter( `SFXStreamWriterPtr` result ) 書き込み用ストリームを取得します。
`SFCError`	Read( `VoidPtr` buffer , `UInt32Ptr` size ) 読み込み用ストリームを使わずにストレージからデータを読み込みます。
`SFCError`	ScheduleRead( `CallbackSPP` spp , `VoidPtr` reference ) 読み込み用ストリームを使わないストレージからのデータ読み込みをスケジュールします。
`SFCError`	ScheduleWrite( `CallbackSPP` spp , `VoidPtr` reference ) 書き込み用ストリームを使わないストレージへのデータ書き込みをスケジュールします。
`SFCError`	Write( `VoidConstPtr` buffer , `UInt32Ptr` size ) 書き込み用ストリームを使わずにストレージにデータを書き込みます。

型
CallbackSPP コールバック関数を表す型です。

SFXStorage::SFXStorage

SFXStorage クラスのコンストラクタです。

[ protected, explicit ]
SFXStorage(Void);

SFXStorage::~SFXStorage

SFXStorage クラスのデストラクタです。

[ public, virtual ]
virtual ~SFXStorage(Void);

SFXStorage::AsSFBAStream

内部で管理されているストレージのインスタンスを SFBAStream クラスのインスタンスに変換します。

[ public, pure-virtual, const ]
SFCError AsSFBAStream(
    SFBAStreamSmpPtr result   // 結果の SFBAStream クラスのインスタンスへのポインタ
);

引数

result: 変換後の SFBAStream クラスのインスタンスへのポインタを指定します。

解説

SFXStorage::AsSFBStream 関数は純粋仮想関数です。

SFXStorage::AsSFBSource

内部で管理されているストレージのインスタンスを SFBSource クラスのインスタンスに変換します。

[ public, pure-virtual, const ]
SFCError AsSFBSource(
    SFBSourceSmpPtr result   // 結果の SFBSource クラスのインスタンスへのポインタ
);

引数

result: 変換後の SFBSource クラスのインスタンスへのポインタを指定します。

解説

SFXStorage::AsSFBSource 関数は純粋仮想関数です。

SFXStorage::Cancel

データの読み書きをキャンセルします。

[ public, virtual ]
Void Cancel(Void);

解説

SFXStorage::Cancel 関数は純粋仮想関数です。

SFXStorage::GetStreamReader

読み込み用ストリームを取得します。

[ public, virtual ]
SFCError GetStreamReader(
    UInt32 size                 // バッファサイズ
    SFXStreamReaderPtr result   // 読み込み用ストリームへのポインタ
);

[ public, virtual ]
SFCError GetStreamReader(
    SFXStreamReaderPtr result   // 読み込み用ストリームへのポインタ
);

解説

SFXStorage::GetStreamReader 関数は純粋仮想関数です。

SFXStorage::GetStreamWriter

書き込み用ストリームを取得します。

[ public, virtual ]
SFCError GetStreamWriter(
    UInt32 size                 // サイズ
    SFXStreamWriterPtr result   // 書き込み用ストリームへのポインタ
);

[ public, virtual ]
SFCError GetStreamWriter(
    SFXStreamWriterPtr result   // 書き込み用ストリームへのポインタ
);

解説

SFXStorage::GetStreamWriter 関数は純粋仮想関数です。

SFXStorage::Read

読み込み用ストリームを使わずにストレージからデータを読み込みます。

[ public, virtual ]
SFCError Read(
    VoidPtr buffer   // 読み込んだデータを格納するバッファ
    UInt32Ptr size   // バッファのサイズ、読み込んだデータのサイズ
);

引数

buffer: 読み込んだデータを格納するバッファ
size: SFXStorage::Read 関数の呼び出し時は、バッファのサイズを指定します。 SFXStorage::Read 関数が終了すると、読み込んだデータのサイズが格納されます。

解説

SFXStorage::Read 関数は純粋仮想関数です。

SFXStorage::ScheduleRead

読み込み用ストリームを使わないストレージからのデータ読み込みをスケジュールします。

[ public, virtual ]
SFCError ScheduleRead(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数に渡すデータ
);

解説

SFXStorage::ScheduleRead 関数は純粋仮想関数です。

SFXStorage::ScheduleWrite

書き込み用ストリームを使わないストレージへのデータ書き込みをスケジュールします。

[ public, virtual ]
SFCError ScheduleWrite(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数へのポインタ
);

解説

SFXStorage::ScheduleWrite 関数は純粋仮想関数です。

SFXStorage::Write

書き込み用ストリームを使わずにストレージにデータを書き込みます。

[ public, virtual ]
SFCError Write(
    VoidConstPtr buffer   // 書き込むデータ
    UInt32Ptr size        // 書き込むデータのサイズ、書き込んだデータのサイズ
);

引数

buffer: 書き込むデータを指定します。
size: SFXStorage::Write 関数の呼び出し時は、書き込むデータのサイズを指定します。 SFXStorage::Write 関数が終了すると、実際に書き込んだデータのサイズが格納されます。

解説

SFXStorage::Write 関数は純粋仮想関数です。

SFXStorage::CallbackSPP

コールバック関数を表す型です。

typedef Void(* SFXStorage::CallbackSPP)(SFCError error, VoidPtr reference)