1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

merged dalay and rate limit node

This commit is contained in:
Ben Hardill 2013-10-02 11:03:43 +01:00
parent e7266ba2b6
commit 85bf6ab51f
4 changed files with 83 additions and 124 deletions

View File

@ -16,21 +16,36 @@
<!-- First, the content of the edit dialog is defined. --> <!-- First, the content of the edit dialog is defined. -->
<script type="text/x-red" data-template-name="delay"> <script type="text/x-red" data-template-name="delay">
<div class="form-row"> <div class="form-row">
<label for="node-input-topic"><i class="icon-tasks"></i> Delay</label> <label for="node-input-pauseType"><i class="icon-tasks"></i> Type</label>
<select id="node-input-pauseType">
<option value="delay">Delay</option>
<option value="rate">Rate Limit</option>
</select>
</div>
<div id="delay-details" class="form-row">
<label for="node-input-timeout"><i class="icon-wrench"></i> Delay</label>
<input type="text" id="node-input-timeout" placeholder="Time"> <input type="text" id="node-input-timeout" placeholder="Time">
</div> </div>
<div id="rate-details" class="form-row">
<label for="node-input-rate"><i class="icon-wrench"></i> Rate</label>
<input type="text" id="node-input-rate" placeholder="msg/second">
</div>
<div class="form-row"> <div class="form-row">
<label for="node-input-name"><i class="icon-tag"></i> Name</label> <label for="node-input-name"><i class="icon-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips">Delay value in seconds, Rate value in messages per second</div>
</script> </script>
<!-- Next, some simple help text is provided for the node. --> <!-- Next, some simple help text is provided for the node. -->
<script type="text/x-red" data-help-name="delay"> <script type="text/x-red" data-help-name="delay">
<p>Introduces a delay into a flow</p> <p>Introduces a delay into a flow or rate limts messges</p>
<p>Default delay is 5 seconds but can be configured</p> <p>Default delay is 5 seconds and rate limit of 1 msg/second, but both can be configured</p>
</script> </script>
<!-- Finally, the node type is registered along with all of its properties --> <!-- Finally, the node type is registered along with all of its properties -->
@ -40,16 +55,42 @@
color:"#E6E0F8", color:"#E6E0F8",
defaults: { // defines the editable properties of the node defaults: { // defines the editable properties of the node
name: {value:""}, // along with default values. name: {value:""}, // along with default values.
timeout: {value:"5", required:true, validate:RED.validators.number()} pauseType: {value:"delay", required:true},
timeout: {value:"5", required:true, validate:RED.validators.number()},
rate: {value:"1", required:true, validate:RED.validators.number()}
}, },
inputs:1, // set the number of inputs - only 0 or 1 inputs:1, // set the number of inputs - only 0 or 1
outputs:1, // set the number of outputs - 0 to n outputs:1, // set the number of outputs - 0 to n
icon: "arrow-in.png", // set the icon (held in public/icons) icon: "arrow-in.png", // set the icon (held in public/icons)
label: function() { // sets the default label contents label: function() { // sets the default label contents
return this.name||"delay "+this.timeout+" s"; if (this.pauseType == "delay") {
return this.name||"delay "+this.timeout+" s";
} else if (this.pauseType == "rate") {
return this.name||"limit "+this.rate+" msg/s";
}
return "foo";
}, },
labelStyle: function() { // sets the class to apply to the label labelStyle: function() { // sets the class to apply to the label
return this.name?"node_label_italic":""; return this.name?"node_label_italic":"";
},
oneditprepare: function() {
if (this.pauseType == "delay") {
$("#delay-details").show();
$("#rate-details").hide();
} else if (this.pauseType == "rate") {
$("#delay-details").hide();
$("#rate-details").show();
}
$("#node-input-pauseType").on("change",function() {
if (this.value == "delay") {
$("#delay-details").show();
$("#rate-details").hide();
} else if (this.value == "rate") {
$("#delay-details").hide();
$("#rate-details").show();
}
});
} }
}); });
</script> </script>

View File

@ -23,27 +23,53 @@ var RED = require("../../red/red");
function DelayNode(n) { function DelayNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
this.pauseType = n.pauseType;
this.timeout = n.timeout * 1000; this.timeout = n.timeout * 1000;
this.rate = 1000/n.rate;
this.name = n.name; this.name = n.name;
this.idList = []; this.idList = [];
this.buffer = [];
var node= this;
this.on("input", function(msg) { if (this.pauseType == "delay") {
var node= this; this.on("input", function(msg) {
var id; var node= this;
id = setTimeout(function(){ var id;
node.idList.splice(node.idList.indexOf(id),1); id = setTimeout(function(){
node.send(msg); node.idList.splice(node.idList.indexOf(id),1);
}, node.timeout); node.send(msg);
this.idList.push(id); }, node.timeout);
}); this.idList.push(id);
});
} else if (this.pauseType == "rate") {
this.intervalID = setInterval(function() {
if (node.buffer.length > 0) {
node.send(node.buffer.shift());
}
},this.rate);
this.on("input", function(msg) {
this.buffer.push(msg);
if (this.buffer.length > 1000) {
this.warn(this.name + " buffer exceeded 1000 messages");
}
});
}
} }
// register node // register node
RED.nodes.registerType("delay",DelayNode); RED.nodes.registerType("delay",DelayNode);
DelayNode.prototype.close = function() { DelayNode.prototype.close = function() {
for (var i=0; i<this.idList.length; i++ ) {
if (this.pauseType == "delay") {
for (var i=0; i<this.idList.length; i++ ) {
clearTimeout(this.idList[i]); clearTimeout(this.idList[i]);
}
this.idList = [];
} else if (this.pauseType == "rate") {
clearInterval(this.intervalID);
this.buffer = [];
} }
this.idList = [];
} }

View File

@ -1,55 +0,0 @@
<!--
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.
-->
<!-- First, the content of the edit dialog is defined. -->
<script type="text/x-red" data-template-name="rateLimit">
<div class="form-row">
<label for="node-input-topic"><i class="icon-tasks"></i> Rate</label>
<input type="text" id="node-input-timeout" placeholder="msg/second">
</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>
<!-- Next, some simple help text is provided for the node. -->
<script type="text/x-red" data-help-name="rateLimit">
<p>Rate limts msgs</p>
<p>Default is 1 msg per seconds but can be configured</p>
</script>
<!-- Finally, the node type is registered along with all of its properties -->
<script type="text/javascript">
RED.nodes.registerType('rateLimit',{
category: 'function', // the palette category
color:"#E6E0F8",
defaults: { // defines the editable properties of the node
name: {value:""}, // along with default values.
rate: {value:"1", required:true, validate:RED.validators.number()}
},
inputs:1, // set the number of inputs - only 0 or 1
outputs:1, // set the number of outputs - 0 to n
icon: "arrow-in.png", // set the icon (held in public/icons)
label: function() { // sets the default label contents
return this.name||this.topic||"limit "+this.rate+" msg/s";
},
labelStyle: function() { // sets the class to apply to the label
return this.name?"node_label_italic":"";
}
});
</script>

View File

@ -1,53 +0,0 @@
/**
* 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.
**/
// Simple node to introduce a pause into a flow
// Require main module
var RED = require("../../red/red");
// main node definition
function RateLimitNode(n) {
RED.nodes.createNode(this,n);
this.buffer = [];
this.timeout = 1000/n.rate;
this.name = n.name
var node= this
this.intervalID = setInterval(function() {
if (node.buffer.length > 0) {
node.send(node.buffer.shift());
}
},this.timeout);
this.on("input", function(msg) {
this.buffer.push(msg);
if (this.buffer.length > 1000) {
this.warn(this.name + " buffer exceeded 1000 messages");
}
});
}
// register node
RED.nodes.registerType("rateLimit",RateLimitNode);
RateLimitNode.prototype.close = function() {
clearInterval(this.intervalID);
this.buffer = [];
}