BoltzEngine RPC インターフェイス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

addr := "localhost:13009" // gRPC endpoint address

// TLS 通信を行わない場合はこちら
//conn, err := grpc.Dial(addr, grpc.WithInsecure())

// v3.2.0 より Protocol Buffer 3.0 に対応してるため、keep alive を指定します
conn, err := grpc.Dial(
    addr,
    []grpc.DialOption{
        grpc.WithInsecure(),
        grpc.WithKeepaliveParams(keepalive.ClientParameters{
            Time:                time.Second,
            Timeout:             30 * time.Second,
            PermitWithoutStream: true,
        }),
        grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(math.MaxInt32)),
    }...,
)

if err != nil {
    log.Fatalln("Dial:", err)
}
defer conn.Close()
c := pb.NewBoltzGatewayClient(conn)

var key []byte            // APNs 秘密鍵の内容
var cert []byte           // APNs 証明書の内容
var topic string          // Bundle ID
var serviceAccount string // FCM サービスアカウントの中身
msg := pb.Message{
    // APNsトークンが.Tokensに存在しない場合は不要
    ApnsHeader: &apns.Header{
        Address:      "https://api.push.apple.com/",
        KeyPEMBlock:  key,
        CertPEMBlock: cert,
        Topic:        topic,
        PushType:     "alert",
    },
    // FCM登録IDが.Tokensに存在しない場合は不要
    GcmHeader: &gcm.Header{
        RequestURL:     "https://fcm.googleapis.com/v1/",
        ServiceAccount: serviceAccount,
    },
    // ADM登録IDが.Tokensに存在しない場合は不要
    AdmHeader: &adm.Header{
        OriginURL: "https://api.amazon.com",
        TokenURL: "https://api.amazon.com/auth/o2/token",
        ClientID: clientID,
        ClientSecret: clientSecret,
    },
    // WebPushトークンが.Tokensに存在しない場合は不要
    WebpushHeader: &webpush.Header{
        Subject: "mailto:boltz@example.com",
        PrivateKey: privateKey, // VAPID PrivateKey
        PublicKey: publicKey,   // VAPID PublicKey
    },
    Tokens: []string{
        // APNs は"1"、FCM は"2"、WebPush は"4"、ADM は"5"をトークンの先頭に追加してください
        "1(16進文字列表記の APNs トークン)",
        "2(FCM 登録 ID)",
        `4{"v":1,"endpoint":"(WebPush エンドポイント)","p256dh":"(ブラウザ公開鍵)","auth":"(WebPush 乱数)"}`,
        "5(ADM 登録 ID)",
    },
    Priority:   pb.Priority_HIGH,
    Payload:    `{"aps":{"alert":{"title": "test", "body": "hello world"},"sound":"default"}}`,   // iOS 端末へ通知する内容
    Parameters: &gcm.Parameters{Data: map[string]string{"title": "test", "body": "hello world"}}, // Android/FireOS 端末へ通知する内容
    Body:       `{"title": "test", "body": "hello world"}`,                                       // WebPush 対応ブラウザへ通知する内容
    BandWidth:  2000,                                                                             // 1秒あたりの最大通知件数(0なら無制限)
}
stream, err := c.Send(context.Background(), &msg)
if err != nil {
    log.Fatalln("Send:", err)
}
for {
    v, err := stream.Recv()
    if err == io.EOF {
        break
    }
    if err != nil {
        log.Fatalln("Recv:", err)
    }
    switch e := v.Event.(type) {
    case *pb.Event_Failed: // 通知失敗した端末
        x := e.Failed
        fmt.Printf("%v: %s: %v\n", v.Platform, x.Token, x.Kind)
        // x.Kindが
        // - INVALID_TOKEN なら無効なので次から削除した方が良い
        // - INVALID_PAYLOAD ならメッセージがおかしいので見直しが必要(通常は発生しない)
        // - TEMPORARY_ERROR の場合は上記以外のエラー
    case *pb.Event_Renewed: // トークン更新の発生した端末
        x := e.Renewed
        fmt.Printf("%v: %s -> %s\n", v.Platform, x.RecentToken, x.LatestToken)
        // x.RecentTokenがx.LatestTokenに切り替わったので次回からx.LatestTokenを使う
        // x.RecentToken, x.LatestTokenのどちらも、1文字目にはサービスIDを含む
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

req := &apns.Request{
    Addr:       "https://api.push.apple.com/",
    Credential: config.Credential(),
    Messages:   []*Message{},
}
for i, token := range tokens {
    msg := &apns.Message{
        ID:      uint32(i),
        Token:   token,
        Payload: []byte(`{"aps":{"alert":{"title": "test", "body": "hello world"},"sound":"default"}}`),
    }
    req.Messages = append(req.Messages, msg)
}
c, err := rpc.Dial("tcp", "boltz-server:13010")
if err != nil {
    log.Fatal("Dial:", err)
}
defer c.Close()
 
var resp apns.Response
err = c.Call("BoltzEngine.BroadcastMessagesToAPNs", req, &resp)
if err != nil {
    log.Fatal("Call:", err)
}

1
2
3

c := pb.NewBoltzGatewayClient(conn)
var query pb.StatisticsQuery
v, err := c.FetchStatistics(context.Background(), &q)

1
2
3

c := pb.NewBoltzGatewayClient(conn)
msg := pb.Message{ ... }
stream, err := c.Send(context.Background(), &msg)

1
2
3

c := pb.NewBoltzGatewayClient(conn)
h := apns.Header{ ... }
stream, err := c.FetchFeedback(context.Background(), &h)

1
2
3

req := &apns.Request{ ... }
var resp apns.Response
err = client.Call("BoltzEngine.BroadcastMessagesToAPNs", req, &resp)

1
2
3

req := &apns.FBRequest{ ... }
var resp apns.FBResponse
err = client.Call("BoltzEngine.ReceiveFeedbackFromAPNs", req, &resp)

1
2
3
4
5
6

req := &gcm.Request{
    URL: "https://fcm.googleapis.com/v1/",
    ...
}
var resp gcm.Response
err = client.Call("BoltzEngine.BroadcastMessagesToGCM", req, &resp)

1
2
3
4
5
6

req := &gcm.Request{
    URL: "fcm-xmpp.googleapis.com:5235",
    ...
}
var resp gcm.Response
err = client.Call("BoltzEngine.BroadcastMessagesToGCM", req, &resp)

1
2
3

req := &webpush.Request{ ... }
var resp webpush.Response
err = client.Call("BoltzEngine.BroadcastMessagesToWebPush", req, &resp)

1
2
3

req := ""
var resp boltz.MasterActivity
err = client.Call("BoltzEngine.QueryActivities", req, &resp)