Add WebSocket nodes

2025-03-01 10:36:34 +00:00 · 2013-11-22 21:28:05 +00:00
parent 7463ef92cb
commit 88be896f1c
2 changed files with 254 additions and 0 deletions
--- a/nodes/core/io/22-websocket.html
+++ b/nodes/core/io/22-websocket.html
@@ -0,0 +1,130 @@
+<!--
+  Copyright 2013 IBM Corp.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+<!-- WebSocket Input Node -->
+<script type="text/x-red" data-template-name="websocket in">
+    <div class="form-row">
+        <label for="node-input-server"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket in">
+    <p>WebSocket input node. Uses the specified server configuration and outputs in response to a <i>'message'</i> event.</p>
+    <p>Outputs an object called <b>msg</b> containing <b>msg.payload</b>.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket in',{
+        category: 'input',
+        defaults: {
+            name: {value:""},
+            server: {type:"websocket-listener"}
+        },
+        color:"rgb(215, 215, 160)",
+        inputs:0,
+        outputs:1,
+        icon: "white-globe.png",
+        label: function() {
+            var wsNode = RED.nodes.node(this.server);
+            return this.name||(wsNode?"[ws] "+wsNode.label():"websocket");
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
+
+<!-- WebSocket out Node -->
+<script type="text/x-red" data-template-name="websocket out">
+    <div class="form-row">
+        <label for="node-input-server"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket out">
+    <p>WebSocket out node. Uses the specified server configuration to send the <b>msg.payload</b> to connected clients.</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket out',{
+        category: 'output',
+        defaults: {
+            name: {value:""},
+            server: {type:"websocket-listener", required:true}
+        },
+        color:"rgb(215, 215, 160)",
+        inputs:1,
+        outputs:0,
+        icon: "white-globe.png",
+        align: "right",
+        label: function() {
+            var wsNode = RED.nodes.node(this.server);
+            return this.name||(wsNode?"[ws] "+wsNode.label():"websocket");
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        }
+    });
+</script>
+
+<!-- WebSocket Server configuration node -->
+<script type="text/x-red" data-template-name="websocket-listener">
+    <div class="form-row">
+        <label for="node-config-input-path"><i class="icon-bookmark"></i> Path</label>
+        <input type="text" id="node-config-input-path" placeholder="/ws/example">
+    </div>
+    <div id="node-config-ws-tip" class="form-tips">This path will be relative to <code><span id="node-config-ws-path"></span></code>.</div>
+</script>
+
+<script type="text/x-red" data-help-name="websocket-listener">
+   <p>This configuration node creates a WebSocket Server using the specified path</p>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('websocket-listener',{
+        category: 'config',
+        defaults: {
+            path: {value:"",required:true,validate:RED.validators.regex(/^((?!\/debug\/ws).)*$/) }
+        },
+        inputs:0,
+        outputs:0,
+        label: function() {
+            var root = document.location.pathname.slice(0,-1);
+            root += this.path;
+            return root;
+        },
+        oneditprepare: function() {
+            var root = document.location.pathname.slice(0,-1);
+            if (root == "") {
+                $("#node-config-ws-tip").hide();
+            } else {
+                $("#node-config-ws-path").html(root);
+                $("#node-config-ws-tip").show();
+            }
+            //document.getElementById("node-config-wsdocpath").innerHTML=
+        }
+    });
+</script>