• サポート
• BoltzEngine API リファレンス

BoltzEngine API リファレンス

• BoltzEngine RPC インターフェイス

  BoltzEngine が持つ RPC インターフェイスについて解説します。

  • インターフェイスの種類BoltzEngine は gRPC と Go 言語の net/rpc インターフェイスを持ち、それぞれのメソッドを呼び出して動作します。
  • gRPC メソッド一覧BoltzEngine の gRPC インターフェイスが提供するメソッドについて、概要と使用方法について解説します。
  • net/rpc メソッド一覧BoltzEngine の RPC インターフェイスが提供するメソッドについて、概要と使用方法について解説します。
• BoltzEngine gRPC リファレンス

  BoltzEngine が提供する gRPC のメソッド・オブジェクトに関する説明です。

  • service BoltzGatewayBoltzEngine に対するリクエストを送信するサービスです。
  • message Message送信する1つのメッセージを表すオブジェクトです。
  • message apns.HeaderAPNs の認証情報を表すオブジェクトです。
  • message gcm.HeaderFCM の認証情報を表すオブジェクトです。
  • message webpush.HeaderWebPush の認証情報を表すオブジェクトです。
  • message adm.HeaderADM の認証情報を表すオブジェクトです。
  • message Parameters送信する FCM メッセージ内容を表すオブジェクトです。
  • message Event送信時に発生するトークン変更・エラー等のイベントオブジェクトです。
  • message DeliveryFailure送信失敗イベントの内容を表すオブジェクトです。
  • message TokenRenewalトークン変更イベントの内容を表すオブジェクトです。
  • message UnavailableTokenEventAPNs 無効トークン取得時に発生するイベントを表すオブジェクトです。
  • message StatisticsQuery性能情報取得クエリを表すオブジェクトです。
  • message MasterStatisticsBoltzEngine Master の性能情報を表すオブジェクトです。
  • message SlaveStatisticsBoltzEngine Slave の性能情報を表すオブジェクトです。
  • message MemoryStatisticsメモリの性能情報を表すオブジェクトです。
  • enum Priorityメッセージの優先順位を表す値です。
  • enum FailureKind送信失敗の内容を表す値です。
  • enum Platformプラットフォームを表す値です。
• BoltzEngine HTTP API ゲートウェイ

  BoltzEngine の RPC インターフェイスを HTTP からアクセスできるようにするゲートウェイサービスです。これは BoltzEngine 本体とは別のサービスとなっており、HTTP と RPC インターフェイスとの仲立ちを行います。

  • 概要BoltzEngine HTTP API ゲートウェイは BoltzEngine v1.1 以降で boltz-http-proxy コマンドとして同梱されます。
• boltz コマンドマニュアル

  boltz コマンドのユーザマニュアルです

  • masterサブコマンドboltz masterはBoltzEngineの配信マネージャサーバを起動します。
  • slaveサブコマンドboltz slaveはmasterからのメッセージリクエストを待ち、。
  • statusサブコマンドboltz statusは -addr オプションでmasterが待ち受けるアドレスを指定し、。
  • 実行例以下の例では、slaveを2つ起動し、masterから2つのslaveを利用するように実行しています。
  • ログboltz masterとboltz slaveはどちらも、-logオプションでログの出力先を変更できます。
• オブジェクト一覧

  BoltzEngine との通信で使用するオブジェクトの一覧です。

  • 基本型一覧BoltzEngine API インターフェイスで扱うデータ型は以下の通りです。