arms_hb_stop()

関数

void arms_hb_stop(arms_context_t *ctx)

呼び出し方向

アプリケーション->libarms

目的

Heartbeat情報のサーバへの送信をを停止する。

説明

libarms は arms_event_loop() 実行中、一定間隔で arms_hb_store_statistics_cb_t() コールバックを呼び出し、Heartbeat情報を収集したのちサーバに送信するが、本関数を呼ぶことで送信を一時的に停止することができる。 なお、コールバック呼び出しは引き続き実行されるため、コールバック内で arms_hb_start() を呼ぶことで送信を再開させることができる。 arms_event_loop() が終了すると停止状態はリセットされ、次回 arms_event_loop() 実行時には送信状態となる。

引数

arms_context_t *ctx

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

返り値

なし

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

可能

ヒストリ

このAPIはVer5.00で追加された。