arms_dump_state()

関数

int arms_dump_state(arms_context_t *ctx, char *state, size_t size)

呼び出し方向

アプリケーション->libarms

目的

内部ステートを指定されたメモリ領域に書き出す。

説明

arms_pull() によりLS およびRS アクセスに成功した後に呼び出すこと。 書き出したメモリ内容を不揮発性メモリに保存するなどしておき、 次回起動後に arms_restore_state() を用いて内部ステートを復帰 させることで、LS アクセスを省いてPush 可能状態に移行することが 可能となる。

引数

arms_context_t *ctx

内部ステートを保持するコンテキスト構造体ポインタ。 arms_init() により取得したポインタをそのまま指定する。

char *state

内部ステート保存領域のアドレス。 arms_size_of_state() で得られるサイズ以上の保存領域を用意する必要がある。

size_t size

内部ステート保存領域のサイズ。

返り値

0

正常終了

非0

異常終了( エラーコード体系 参照)

ARMS_ESIZE

サイズが不足している

コールバック関数からの呼び出し

不可

ヒストリ

このAPIはVer2.12で追加された。