nlib
nn::nlib::ZlibInputStream クラスfinal

zlibを用いて圧縮したデータを読み込むためのストリームクラスです。 [詳解]

#include "nn/nlib/ZlibInputStream.h"

+ nn::nlib::ZlibInputStream の継承関係図

公開メンバ関数

errno_t Init () noexcept
 デフォルト設定で初期化します。 [詳解]
 
errno_t Init (const ZlibInputStreamSettings &settings) noexcept
 settings で指定した値に従いストリーミングに利用するバッファ等の設定を行います。 [詳解]
 
基本的なメンバ関数
constexpr ZlibInputStream () noexcept
 デフォルトコンストラクタです。
 
- 基底クラス nn::nlib::InputConverterStream に属する継承公開メンバ関数
errno_t SetStream (InputStream *istr) noexcept
 変換前のデータを読み込む入力ストリームを設定します。 [詳解]
 
InputStreamGetStream () const noexcept
 変換前のデータを読み込む入力ストリームを取得します。 [詳解]
 
- 基底クラス nn::nlib::InputStream に属する継承公開メンバ関数
errno_t GetErrorValue () const noexcept
 エラー値を取得します。 [詳解]
 
size_t Pos () const noexcept
 ストリーム上の現在位置を返します。 [詳解]
 
uint64_t Pos64 () const noexcept
 ストリーム上の現在位置を64bit値で返します。 [詳解]
 
bool IsEos () noexcept
 ストリームを最後まで読み終えている場合trueを返します。最後まで読み終えていない場合やエラーが発生している場合はfalseを返します。 [詳解]
 
int Read () noexcept
 ストリームから1バイトを読み込みます。 [詳解]
 
int Peek () noexcept
 ストリームを消費せずに次の1バイトを読み込みます。 [詳解]
 
size_t Skip (size_t nbytes) noexcept
 nbytes を読み飛ばします。 [詳解]
 
size_t Read (void *ptr, size_t nbytes) noexcept
 ptr で示されるメモリにnbytes 読み込みます。 [詳解]
 
bool Close () noexcept
 ストリームを閉じます。成功した場合にはtrueを返します。 [詳解]
 
 operator bool () const
 内部でエラーが発生していなければtrueを返します。
 
constexpr InputStream () noexcept
 コンストラクタです。派生クラスから呼び出されます。
 
virtual ~InputStream () noexcept
 デストラクタです。派生クラスから呼び出されます。
 

その他の継承メンバ

- 基底クラス nn::nlib::InputStream に属する継承限定公開メンバ関数
void ResetBuffer (void *p, size_t nbytes) noexcept
 InputStreamが持つバッファを設定します。 [詳解]
 
void SetError (errno_t e) const noexcept
 InputStreamにエラーを設定します。 [詳解]
 

詳解

zlibを用いて圧縮したデータを読み込むためのストリームクラスです。

説明
zlibで圧縮したデータをストリーミングで読み込みます。 サイズの大きいデータでもストリーミングして読み込むことができます。
利用方法は、オブジェクトの構築後、Init()でバッファ等をセットアップし、SetStream()でベースストリームに関連付けてから、InputStreamと同様にデータを読み出します。
このストリームをクローズするとベースストリームはデタッチ(SetStream()以前の状態に戻る)されます。 ベースストリーム自体をクローズすることはありません。
データの読込中発生するエラーは、以下のようなものがあります。 zlibのエラーはerrnoのエラー値が設定されます。
  • Z_DATA_ERRORの場合はEILSEQ
  • Z_NEED_DICTの場合はEILSEQ
  • Z_STREAM_ERRORの場合はEIO
  • Z_MEM_ERRORの場合はENOMEM
  • Z_BUF_ERRORの場合はENOBUFS
  • 不意のEOFが見つかった場合はEOF
  • ベースストリームが失敗した場合はEIO
次に、SetStream()関数の動作について以下に解説します。
内部ではinflateInit2を呼び出していて、データの展開のための初期化を行なっています。 現在のところinflateInit2windowBits には47が指定されています。 z_streamzalloc, zfree, opaque にはいずれもZ_NULL が指定されています。
また、zlibinflateInit2が返すエラーについては以下のような変換が行われています。
  • Z_MEM_ERRORENOMEMに変換されます。
  • Z_STREAM_ERROREINVALに変換されます。
  • Z_VERSION_ERRORENOTSUPに変換されます。
オブジェクトの状態遷移
オブジェクトの状態遷移の概略は以下のとおりです。
dot_inline_dotgraph_13.png
各種例:
misc/usezlib/usezlib.cpp.

ZlibInputStream.h53 行目に定義があります。

関数詳解

◆ Init() [1/2]

nn::nlib::ZlibInputStream::Init ( )
inlinenoexcept

デフォルト設定で初期化します。

戻り値
0以外ならエラー
説明
以下のコードと同じです。
ZlibInputStreamSettings settings;

ZlibInputStream.h58 行目に定義があります。

◆ Init() [2/2]

nn::nlib::ZlibInputStream::Init ( const ZlibInputStreamSettings settings)
noexcept

settings で指定した値に従いストリーミングに利用するバッファ等の設定を行います。

引数
[in]settingsバッファ等の設定データ
戻り値
0エラーは発生していません。
EALREADY既にInit()が実行されている場合
EINVALバッファサイズが1024未満の場合、及びsettings で指定されたバッファの片方のみがNULLだった場合
ENOMEMバッファの動的確保が失敗した場合

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