Triggerノードを使う（その2）

ここのところずっとNode-REDのサンプルを見ながら各ノードの使い方を確認しています。頭出しの記事はこちらをご確認ください。今回からTriggerノードシリーズです。

メッセージが来なくなったら定期的にメッセージを送り続ける

見出しを読んだだけだとなんのこっちゃ？という感じではありますが、サンプルを見ていきます。確認するサンプルは「flows > node-red > function > trigger > 03 - Send placeholder message when a stream stops sending」です。


Triggerノードが2つあるのでそれぞれ確認していきます。まずは下流の「resend every 2s」から。内容を言葉で表現すると以下の通りです。
  • メッセージを受け取ったら、それ以降2秒間隔でmsg.payloadに「0」を設定したメッセージを出力する
  • msg.payloadの値が「reset」だったら初期化（繰り返し動作を停止）する


続いて左側の「trigger 2s」。内容は以下のとおりです。
  • メッセージを受け取ったらmsg.payloadに文字列「reset」を設定したメッセージを送信する
  • 2秒以内に新たなメッセージを受け取らなければmsg.payloadに「true」を設定したメッセージを送信する


この2つのTriggerノードを組み合わせると、以下の挙動になります。
  • 2秒以内にTriggerノード「trigger 2s」がメッセージを受け取っていればログ出力されません
    • Injectノードを連打し続けると確認できます
  • Triggerノード「trigger 2s」がメッセージを受け取らない時間が2秒以上あくとTriggerノード「resend every 2s」がメッセージを出力し続けます
常に動き続けていてほしいシステムが止まったら警告メッセージを出す、みたいな用途で使えそうです。

タイムアウト機構を実現する2

次に確認するサンプルは「flows > node-red > function > trigger > 04 - Timeout processing using trigger node」です。タイムアウト機構を実現します。タイムアウトといえば、前回の記事で一定時間メッセージを受信しなかったらメッセージを送信するサンプルを確認しましたが、今回はもう少し複雑です。


左から順番に見ていきます。まずはInjectノードから。msg.payloadに数値「1」を設定して出力しています。


続いてTriggerノード「trigger 3s」の内容は次のとおりです。
  • 受信したメッセージを第一のポートにそのまま出力
  • 3秒待って、msg.payloadに文字列「0」を設定したメッセージを第二のポートに出力


続いてTriggerノードの第一ポートに繋がっているFunctionノードです。動作は次の通りです。
  • msg.payloadに指定された時間（この場合1秒）待って、msg.payloadに文字列「done 〜s」を設定したメッセージを送信

一方、Triggerノードの第二ポートに繋がっているChangeノードはmsg.payloadに文字列「timeout」を設定したメッセージを出力しています。


FunctionノードとChangeノードの出力はどちらもTriggerノード「trigger 10s」につながっています。ここまでの動作を整理すると次のようになります。
  • Triggerノード「trigger 3s」でメッセージが2つに分岐します
    • 実はどちらも同じmsg._msgidを持っており、これは後述するTriggerノード「trigger 10s」で利用します
  • Functionノードを通るメッセージはInjectノードで指定した時間（1秒または5秒）遅れてTriggerノード「trigger 10s」に流れます
  • 一方、Changeノードを流れるメッセージは3秒（固定値）遅れてTriggerノード「trigger 10s」に流れます
さて、いよいよ最後のTriggerノード「trigger 10s」を確認します。内容は次のとおりです。
  • メッセージを受信したらそれをそのまま出力し、その後10秒間何もしません
  • この動作は「msg._msgid」毎に動きます
    • つまり、値が同じ「msg._msgid」であれば、最初に届いたメッセージの内容を出力し、後から届いたメッセージを破棄する挙動になります。

Changeノードを通るメッセージの遅延は3秒で固定されているので、Injectノードで5秒遅延するメッセージを流すと、Triggerノード「trigger 10s」に届くメッセージの順序が逆転してtimeoutします。

一個ずつ説明するとやたらと複雑ですが、こんな感じです。

まとめ

今回確認したTriggerノードの機能をまとめます。
  • Triggerノードが後から出力するポートを第二のポートから出力してフローを分岐できます
  • 同じmsg._msgidを持つメッセージに同じ条件を適用してまとめて扱うことができます
これでTriggerノードシリーズ終了です。

コメント

コメントを投稿

このブログの人気の投稿

Execノードを使う

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はExecノードです。Execノードを使うと外部のコマンドを実行することができます。コマンドが出力した、標準出力や標準エラー出力などをノードから出力できます。 標準出力の内容を出力する 最初に確認するサンプルは「 flows > node-red > function > exec > 01 - Get standard output from external command 」です。 Execノードのプロパティを見ると以下の通りになっています。 実行コマンドは「 echo 」 msg.payload で受け取った値を引数として利用 出力モードは「 コマンド終了時 - execモード 」 コマンド終了時に結果を出力します Execノードには出力ポートが3つあります。 標準出力 標準エラー出力 返却コード 実行すると、標準出力には「 Hello World! 」、返却コードには「 {code : 0} 」が出力されます。この挙動は特に説明することはないかと思います。 標準エラー出力の内容を出力する 次に確認するサンプルは「 flows > node-red > function > exec > 02 - Get error output from external command 」です。外部コマンドのエラーをポートに出力します。中身は先程のサンプルフローとほぼ同じですが、Execノードで存在しないコマンドを実行しています。 実行すると、以下のログが出力されます。これも説明不要かと思います。 実行中に出力する 最後に確認するサンプルは「 flows > node-red > function > exec > 03 - Run external command in spawn mode 」です。出力がコマンド実行中に行われるのがこれまでのサンプルと違う点です。 コマンドはwhieループ内で2秒おきに「 Hello 」を標準出力に出力し続けます。Spawnモードで実行するとループ内でechoコマンドが実行されるたびにログが出力されます。サービスっぽい挙動をす
続きを読む

SendGridのX-SMTPAPIヘッダの使い方（Section Tags、Substitution Tags編）

イメージ
前回に引き続き SendGrid についてです。 今回は SMTP API を使ってみました。 SMTP APIについて SendGridのSMTP APIは基本的には普通のSMTPプロトコルに則ったものですが、X-SMTPAPIヘッダというカスタムヘッダを使うことで機能を拡張することができます。 X-SMTPAPIヘッダについて X-SMTPAPIヘッダはSMTPプロトコルの拡張ヘッダです。 X-SMTPAPI: { "category": "newuser" } みたいな感じでJSON形式でパラメータを与えることで機能を拡張します。 Section TagsとSubstitution Tagsについて 今回はSMTP APIで使える機能のうちSection TagsとSubstitution Tagsを使ってみました。 Section TagsとSubsitution Tagsは送信メールの内容を宛先毎に特定の文字列を置換するための機能です。toと合わせて使うことで機能します。 例えば、X-SMTPAPIヘッダの値を以下のような形にします。 { "to": ["test1@xxx.xxx", "test2@yyy.yyy"], "sub": { "-body-": [ "-bodyFemale-", "-bodyMale-" ], "-favorite-": [ "バナナ", "カツオ" ], " "-nickname-": [ "ミキ", "サブロー" ] }, "section": { " "-bodyFemale-": "-nickname-さん！女性向けの商品のご紹介です。", "-bodyMale": "-nickn
続きを読む

Joinノードを使う（その4）

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はJoinノードの4回目です。終わらねぇ。 確認するサンプルは、 前回 に引き続き「 読み込み > サンプル > flows > node-red > sequence > join > 02 - Manual join mode 」です。 メッセージを結合してkey/valueオブジェクトにする 5段目のフローから見ていきます。ざっくりとした流れは以下のとおりです。 DataノードでCSVデータを送信する CsvノードでCSVデータをJSONオブジェクトに変換する msg.payloadには以下のような値が指定されたメッセージ4つに分解される { name: "Apple", price: 100 } Changeノードでmsg.payload内の値を以下のプロパティに設定する msg.topic = "Apple"（msg.payload.nameの値） msg.payload = 100（msg.payload.priceの値） Joinノードで、2個の受信メッセージごとにmsg.topicの値をキーとしてkey/valueオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadにJSONオブジェクトが指定されていることを確認できます。 メッセージを結合して結合オブジェクトにする 先ほどは結合した値がkey/valueオブジェクトでしたが、6段目のフローでは単純にオブジェクト結合します。ざっくりとした流れは以下のとおりです。 DataノードでJSON配列を送信する nameをキーに持つオブジェクトとpriceをキーに持つオブジェクトを交互に含んでいます（実際、こんなに都合の良いデータが生成されることはあるんだろうか） Splitノードで配列データを個別のメッセージに分割します Joinノードで、2個の受信メッセージごとにオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadに2個ずつのオブジェクトがJSONオブジェクトに結合されたものが指定されていることを確認できます。ちなみに、Joinノード
続きを読む