libarmsドキュメント

Contents:

• はじめに
  • 提供方法
    • オープンソース版
    • 特定ベンダ向けバイナリ版
  • 提供条件
    • ハードウェア条件
    • ソフトウェア条件
    • ネットワーク条件
  • システム構成
  • libarmsのSAへの組み込み
    • 外部ライブラリのコンパイル方法
    • libarmsのコンパイル方法
• アーキテクチャ
  • コンフィグ
    • Initial-Config
    • Location-Config
    • Service-Config
  • Pull動作における通信
    • 冗長化への対応
    • リトライ動作
  • Push動作における通信
    • 通信手段の合意手順
    • https-tunnel モードでの動作
    • 冗長化への対応
    • リトライ動作
  • Heartbeat通信
    • Heartbeat 送信を行うための準備
    • Heartbeat 送信の開始
    • Heartbeat 送信の停止
    • Heartbeat 送信の一時停止
• SA実装
  • 初期化処理
    • 各種情報の登録
    • Initial-Config の読み込み(特定ベンダ向け)
  • Pull
    • LS-Skip について
  • Push
    • Push 待ち受け開始
    • Pushメッセージ処理
  • イベントコールバック
  • Heartbeat
    • Heartbeat 統計情報の付加
  • 動作情報の取得
    • libarms バージョン情報
    • ARMS プロトコルバージョン情報
    • RS 用情報
    • Heartbeat 送信用情報(特定ベンダ向け)
  • 終了処理
• API Reference
  • Initialize API
    • arms_init()
  • Pull API
    • arms_load_config()
    • arms_register_authkey()
    • arms_register_cert()
    • arms_register_description()
    • arms_set_pull_trigger()
    • arms_set_https_proxy()
    • arms_pull()
  • Push API
    • arms_push_method_query()
    • arms_event_loop()
  • State Cache API
    • arms_size_of_state()
    • arms_dump_state()
    • arms_restore_state()
  • Info API
    • arms_get_rsinfo()
    • arms_get_rs_url()
    • arms_get_rs_tunnel_url()
    • arms_get_proposed_push_port(), arms_get_proposed_push_timeout()
    • arms_get_connection_info()
    • arms_get_app_event_interval()
    • arms_set_app_event_interval()
    • arms_library_ver_major(), arms_library_ver_minor()
    • arms_protocol_ver_major(), arms_protocol_ver_minor()
    • arms_library_ver_string()
  • End API
    • arms_end()
  • Callback API
    • (*arms_config_cb_t)()
    • (*arms_line_ctrl_cb_t)()
    • (*arms_read_config_cb_t)()
    • (*arms_get_status_cb_t)()
    • (*arms_command_cb_t)()
    • (*arms_state_cb_t)()
    • (*arms_log_cb_t)()
    • (*arms_app_event_cb_t)()
    • (*arms_hb_store_statistics_cb_t)()
  • Heartbeat Info API
    • arms_hb_set_cpu_detail_usage()
    • arms_hb_set_cpu_usage()
    • arms_hb_set_disk_usage()
    • arms_hb_set_mem_usage()
    • arms_hb_set_traffic_rate()
    • arms_hb_set_radiowave()
    • arms_get_hbtinfo()
  • Heartbeat Control API
    • arms_hb_stop()
    • arms_hb_start()
    • arms_hb_is_running()
  • Data Types
    • libarms データ構造リファレンス
  • Error Code
    • エラーコード/ログコード体系
• 使用するライブラリ関数一覧
  • libc
  • OpenSSL
• クライアント実装
  • 動作環境
  • 動作
    • Pull オペレーション
    • Push オペレーション
    • Heartbeat監視
    • 処理シーケンス
  • 起動
    • コマンドラインオプション
    • その他
  • コンフィグファイルの書式
    • コンフィグパラメータ
  • コールバックスクリプト
    • スクリプト一般
  • ファイル
  • その他
    • ログ
    • ユーザコンフィグファイル
    • ワーキングディレクトリ
    • バージョン番号

Indices and tables

• 索引
• 検索ページ