開発者向け
定義済み定数
K2HASH PHP Extensionは、いくつかの定数を定義ます。
これらの定数については、こちらを参照してください。
K2hash クラス
K2hashクラスの説明は、こちらを参照してください。
K2hash クラスは、以下に示すメソッドを提供します。
- K2hash::addAttr - キーに属性を追加する
- K2hash::addAttrCryptPass - 値を暗号化するパスワード（暗号鍵）を追加する
- K2hash::addAttrPluginLib - ユーザ定義の動的ライブラリを追加する
- K2hash::addSubkey - キーを紐づける
- K2hash::addSubkeys - 複数のキーを紐づける
- K2hash::cleanCommonAttribute - キーの基本属性を初期化する
- K2hash::close - k2hファイルを閉じる
- K2hash::create - k2hファイルを作成する
- K2hash::disableTransaction - トランザクションを停止する
- K2hash::dumpElementtable - k2hashのハッシュテーブル内部の要素などを表示する
- K2hash::dumpFull - k2hashのハッシュテーブル内部のデータなどを表示する
- K2hash::dumpFullKeytable - k2hashのハッシュテーブルなどを表示する
- K2hash::dumpHead - k2hashのヘッダを表示する
- K2hash::dumpKeytable - k2hashのハッシュテーブルを表示する
- K2hash::enableTransaction - トランザクションを開始する
- K2hash::getAttrInfos - 属性を取得する
- K2hash::getAttrs - キーに設定されている属性を取得する
- K2hash::getAttrValue - キーに設定されている属性値を取得する
- K2hash::getAttrVersionInfos - 属性のライブラリバージョン情報を表示する
- K2hash::getIterator - K2hIteratorオブジェクトを取得する
- K2hash::getKeyQueue - K2hKeyQueueオブジェクトを取得する
- K2hash::getQueue - K2hQueueオブジェクトを取得する
- K2hash::getStream - k2hashファイルストリームを取得する
- K2hash::getSubkeys - キーに紐づけられたキー（サブキー）の一覧を取得する
- K2hash::getTransactionThreadPool - トランザクション処理用のスレッド数を取得する
- K2hash::getValue - 値を取得する
- K2hash::loadArchive - ファイルからデータをロードする
- K2hash::open - k2hファイルを開く
- K2hash::openMem - 揮発性（メモリ）としてk2hashをオープンする
- K2hash::openRO - k2hファイルを 読み込む
- K2hash::openRW - k2hファイルを編集する
- K2hash::openTempfile - 一時ファイルとしてk2hファイルを編集する
- K2hash::printState - k2hashのデータの状態を表示する
- K2hash::printVersion - ライブラリのバージョンなどを表示する
- K2hash::putArchive - k2hファイルをアーカイブファイルとして保存する
- K2hash::remove - キーを削除する
- K2hash::removeAll - キーと、キーに紐づけられているキー（サブキー）を削除する
- K2hash::rename - キー名を変更する
- K2hash::setCommonAttribute - キーの基本属性を設定する
- K2hash::setTransactionThreadPool - トランザクション処理用のスレッド数を設定する
- K2hash::setValue - キーに値を設定する
- K2hash::transaction - トランザクションを有効また無効にする
- K2hash::unsetTransactionThreadPool - トランザクション処理用のスレッドを利用しない
K2hQueue クラス
K2hQueueクラスの説明は、こちらを参照してください。
K2hQueue クラスは、以下に示すメソッドを提供します。
- K2hQueue::__construct - 新しいK2hQueueオブジェクトを作成する
- K2hQueue::count - キューにある要素の数を取得する
- K2hQueue::dump - キューにある要素を表示する
- K2hQueue::isEmpty - キューが空かどうかを判定する
- K2hQueue::pop - キューから要素を取得する
- K2hQueue::push - キューに要素を追加する
- K2hQueue::read - キューの要素を表示する
- K2hQueue::remove - キューから要素を削除する
K2hKeyQueue クラス
K2hKeyQueueクラスの説明は、こちらを参照してください。
K2hKeyQueue クラスは、以下に示すメソッドを提供します。
- K2hKeyQueue::__construct - 新しいK2hKeyQueueオブジェクトを作成する
- K2hKeyQueue::count - キューにある要素の数を取得する
- K2hKeyQueue::dump - キューにある要素を表示する
- K2hKeyQueue::isEmpty - キューが空かどうかを判定する
- K2hKeyQueue::pop - キューから要素（キーと値のセット）を取得する
- K2hKeyQueue::push - キューに要素（キーと値のセット）を追加する
- K2hKeyQueue::read - キューの要素（キーと値のセット）を表示する
- K2hKeyQueue::remove - キューから要素（キーと値のセット）を削除する
K2hIterator クラス
K2hIteratorクラスの説明は、こちらを参照してください。
K2hIterator クラスは、以下に示すメソッドを提供します。
- K2hIterator::__construct - 新しい K2hIterator オブジェクトを作成する
- K2hIterator::current - 配列内の現在の要素を取得する
- K2hIterator::key - 配列からキーを取得する
- K2hIterator::next - 配列のポインタを一つ進める
- K2hIterator::rewind - 配列のポインタを先頭に戻す
- K2hIterator::valid - ポインタの有効性を調べる
k2hash 関数群
k2hash関数群の説明は、こちらを参照してください。
k2hash 関数群の関数を以下に示します。
- k2hpx_add_attr_crypt_pass - 値を暗号化するパスワード（暗号鍵）を追加する
- k2hpx_add_attr_plugin_library - ユーザ定義の動的ライブラリを追加する
- k2hpx_add_attr - キーに属性を追加する
- k2hpx_add_subkey - キーを紐づける
- k2hpx_add_subkeys - 複数のキーを紐づける
- k2hpx_bump_debug_level - ログレベルを変更する
- k2hpx_clean_common_attr - キーの基本属性を初期化する
- k2hpx_close - k2hファイルを閉じる
- k2hpx_create - k2hファイルを作成する
- k2hpx_da_free - データアクセスハンドルを解放する
- k2hpx_da_get_handle_read - ダイレクトアクセスハンドル(データ読み出し専用)を取得する
- k2hpx_da_get_handle_rw - ダイレクトアクセスハンドル(データ編集用)を取得する
- k2hpx_da_get_handle_write - ダイレクトアクセスハンドル(データ書き込み専用)を取得する
- k2hpx_da_get_handle - ファイル操作方法を指定して、ダイレクトアクセスハンドルを取得する
- k2hpx_da_get_length - データ長を取得する
- k2hpx_da_get_offset - データを読み書き開始する位置を取得する
- k2hpx_da_get_read_offset - データを読みとり開始する位置を取得する
- k2hpx_da_get_value_to_file - 読み取った値をファイルに書き出す
- k2hpx_da_get_value - データを読み取る
- k2hpx_da_get_write_offset - データの書き込み開始する位置を取得する
- k2hpx_da_set_offset - データを読み込むまたは書き込む位置を指定する
- k2hpx_da_set_read_offset - データを読み込む位置を指定する
- k2hpx_da_set_value_from_file - ファイルから書き込むデータを読み込み、直接データを書きこむ位置を指定し、書き込む
- k2hpx_da_set_value - データを書きこむ位置を指定し、書き込む
- k2hpx_da_set_write_offset - データを書き込む位置を指定する
- k2hpx_disable_transaction - トランザクションを停止する
- k2hpx_dump_elementtable - k2hashのハッシュテーブル内部の要素などを表示する
- k2hpx_dump_full_keytable - k2hashのハッシュテーブルなどを表示する
- k2hpx_dump_full - k2hashのハッシュテーブル内部のデータなどを表示する
- k2hpx_dump_head - k2hashのヘッダを表示する
- k2hpx_dump_keytable - k2hashのハッシュテーブルを表示する
- k2hpx_enable_transaction - トランザクションを開始する
- k2hpx_find_first - キー探索用ハンドルを取得する
- k2hpx_find_free - キー探索用ハンドルを解放する
- k2hpx_find_get_key - キーを探索する
- k2hpx_find_get_subkeys - キーに紐づけられたキーを探索する
- k2hpx_find_get_value - キーを探索して値を取得する
- k2hpx_find_next - キー探索用ハンドルを次のキーに移動する
- k2hpx_get_attr_value - キーに設定されている属性値を取得する
- k2hpx_get_attrs - キーに設定されている属性を取得する
- k2hpx_get_subkeys - キーに紐づけられたキー（サブキー）の一覧を取得する
- k2hpx_get_transaction_thread_pool - トランザクション処理用のスレッド数を取得する
- k2hpx_get_value - キーの値を取得する
- k2hpx_keyq_count - K2hKeyQueueキューにある要素の数を取得する
- k2hpx_keyq_dump - K2hKeyQueueキューにある要素を表示する
- k2hpx_keyq_empty - K2hKeyQueueキューが空かどうかを判定する
- k2hpx_keyq_free - K2hKeyQueueキューハンドルを解放する
- k2hpx_keyq_handle - K2hKeyQueueハンドルを取得する
- k2hpx_keyq_pop - K2hKeyQueueキューから要素（キーと値のセット）を取得する
- k2hpx_keyq_push - K2hKeyQueueキューに要素（キーと値のセット）を追加する
- k2hpx_keyq_read - K2hKeyQueueキューの要素（キーと値のセット）を表示する
- k2hpx_keyq_remove - K2hKeyQueueキューから要素（キーと値のセット）を削除する
- k2hpx_load_archive - ファイルからデータをロードする
- k2hpx_load_debug_env - 環境変数を読み込む
- k2hpx_load_hash_library - ハッシュ関数を有効にする
- k2hpx_load_transaction_library - トランザクション用ライブラリを読み込む
- k2hpx_open_mem - k2hash用メモリセグメントにアクセスする
- k2hpx_open_ro - k2hファイルを 読み込む
- k2hpx_open_rw - k2hファイルを編集する
- k2hpx_open_tempfile - 一時ファイルとしてk2hファイルを編集する
- k2hpx_open - k2hファイルを開く
- k2hpx_print_attr_information - 属性情報を表示する
- k2hpx_print_attr_version - 属性のライブラリバージョン情報を表示する
- k2hpx_print_state - k2hashのデータの状態を表示する
- k2hpx_print_version - ライブラリのバージョンなどを表示する
- k2hpx_put_archive - k2hファイルをアーカイブファイルとして保存する
- k2hpx_q_count - K2hQueueキューにある要素の数を取得する
- k2hpx_q_dump - K2hQueueキューにある要素を表示する
- k2hpx_q_empty - K2hQueueキューが空かどうかを判定する
- k2hpx_q_free - K2hQueueキューハンドルを解放する
- k2hpx_q_handle - K2hQueueハンドルを取得する
- k2hpx_q_pop - K2hQueueキューから要素を取得する
- k2hpx_q_push - K2hQueueキューに要素を追加する
- k2hpx_q_read - K2hQueueキューの要素（値）を表示する
- k2hpx_q_remove - K2hQueueキューから要素を削除する
- k2hpx_remove_all - キーと、キーに紐づけられているキー（サブキー）を削除する
- k2hpx_remove - キーを削除する
- k2hpx_rename - キー名を変更する
- k2hpx_set_common_attr - キーの基本属性を設定する
- k2hpx_set_debug_file - ログ出力先ファイル名を指定する
- k2hpx_set_debug_level_error - ライブラリのログレベルをerrorにする
- k2hpx_set_debug_level_message - ライブラリのログレベルをmessage(info相当）にする
- k2hpx_set_debug_level_silent - ライブラリのログを出力しない
- k2hpx_set_debug_level_warning - ライブラリのログレベルをwarningにする
- k2hpx_set_transaction_thread_pool - トランザクション処理用のスレッド数を設定する
- k2hpx_set_value - キーに値を設定する
- k2hpx_transaction - トランザクションを有効また無効にする
- k2hpx_unload_hash_library - ハッシュ関数ライブラリを取り外す
- k2hpx_unload_transaction_library - トランザクション用ライブラリを無効にする
- k2hpx_unset_debug_file - ログ出力先を標準エラーに指定する
- k2hpx_unset_transaction_thread_pool - トランザクション処理用のスレッドを利用しない