arms_set_rs_pull_order()

関数

int arms_set_rs_pull_order(arms_context_t *ctx, enum arms_set_rs_pull_order)

呼び出し方向

アプリケーション->libarms

目的

RS PULL における回線の接続試行の順序を変更する。

説明

arms_pull() の動作において RS PULL は LS サーバから取得した Location-Config の回線情報に基づき接続試行を行うが、 事前に本関数を呼び出すことで試行する回線順序を指定することができる。

引数

arms_context_t *ctx

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

enum arms_set_rs_pull_order order

次のいずれかを指定する。

ARMS_FOLLOW_LOCATION_CONFIG

Location-Config で指定された順序に従い RS PULL を行う(デフォルト)。 なお、 arms_restore_state() により LS PULL が省略された場合、RS PULL の順序は再設定された内部ステートに従う。

ARMS_START_FROM_LS_PULL_LAST_LINE

Location-Config で指定された回線の内、LS PULL が成功した回線と同種の回線から RS PULL を開始する。 最初の接続試行で RS PULL が成功しやすくなるため、RS PULL における接続試行の時間短縮が期待される。 LS PULL と同種の回線が無い場合は Location-Config で指定された順序に従い RS PULL を行う。 なお、 arms_restore_state() により LS PULL が省略された場合、RS PULL の順序は再設定された内部ステートに従う。

返り値

0

成功

-1

パラメータ不正によるエラー

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

不可

ヒストリ

このAPIはVer6.40で追加された。