node-red-contrib-zyre/zyre-join.html at master · InSourceSoftware/node-red-contrib-zyre · GitHub

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
<script type="text/javascript">
  RED.nodes.registerType('zyre-join', {
    category: 'Zyre',
    color: '#a6bbcf',
    defaults: {
      name: {
        value: 'join',
        required: true
      },
      topic: {
        value: ''
      },
      zyre: {
        value: '',
        type: 'zyre-peer',
        required: true
      }
    },
    inputs: 1,
    outputs: 1,
    icon: 'zeromq.png',
    label: function () {
      return this.name || 'zyre-join'
    }
  })
</script>

<script type="text/html" data-template-name="zyre-join">
  <div class="form-row">
    <label for="node-input-zyre"><i class="fa fa-server"></i> Zyre Peer</label>
    <select id="node-input-zyre"></select>
  </div>
  <div class="form-row">
    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
    <input type="text" id="node-input-name" placeholder="Name">
  </div>
  <div class="form-row">
    <label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
    <input type="text" id="node-input-topic" placeholder="Topic">
  </div>
</script>

<script type="text/html" data-help-name="zyre-join">
  <p>Get notified when a peer joins a group in the Zyre network, or programmatically join a group.</p>

  <h3>Inputs</h3>
  <dl class="message-properties">
    <dt>topic <span class="property-type">string</span></dt>
    <dd>The name of the group to join. Leave blank to pass <code>msg.topic</code>.</dd>
    <dt>payload <span class="property-type">string</span></dt>
    <dd>The payload is only used if topic was left blank and <code>msg.topic</code> was not populated.</dd>
  </dl>

  <h3>Outputs</h3>
  <dl class="message-properties">
    <dt>topic <span class="property-type">string</span></dt>
    <dd>The name of the group that was joined.</dd>
    <dt>payload <span class="property-type">object</span></dt>
    <dd>Information about the peer and group, including <code>identity</code>, <code>name</code>, and <code>group</code>.</dd>
  </dl>

  <h3>Details</h3>
  <p>This node outputs a message when a peer joins a group. You can use this to track group membership.</p>
</script>