node-red/nodes/core/89-delay.html

118 lines
4.7 KiB
HTML
Raw Normal View History

2013-09-27 11:55:46 +02:00
<!--
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.
-->
<script type="text/x-red" data-template-name="delay">
<div class="form-row">
<label for="node-input-pauseType"><i class="icon-tasks"></i> Action</label>
<select id="node-input-pauseType" style="width:270px !important">
<option value="delay">Delay message</option>
<option value="rate">Limit message rate</option>
2013-10-02 12:03:43 +02:00
</select>
</div>
<div id="delay-details" class="form-row">
<label for="node-input-timeout"><i class="icon-time"></i> For</label>
<input type="text" id="node-input-timeout" placeholder="Time" style="direction:rtl; width:50px !important">
<select id="node-input-timeoutUnits" style="width:200px !important">
<option value="milliseconds">Milliseconds</option>
<option value="seconds">Seconds</option>
<option value="minutes">Minutes</option>
<option value="hours">Hours</option>
<option value="days">Days</option>
</select>
2013-09-27 11:55:46 +02:00
</div>
2013-10-02 12:03:43 +02:00
<div id="rate-details" class="form-row">
<label for="node-input-rate"><i class="icon-time"></i> To</label>
<input type="text" id="node-input-rate" placeholder="1" style="direction:rtl; width:40px !important">
<label for="node-input-rateUnits" style="width:120px !important">message(s) per</label>
<select id="node-input-rateUnits" style="width:140px !important">
<option value="second">Second</option>
<option value="minute">Minute</option>
<option value="hour">Hour</option>
<option value="day">Day</option>
</select>
2013-10-02 12:03:43 +02:00
</div>
2013-09-27 11:55:46 +02:00
<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>
2013-09-27 11:55:46 +02:00
<script type="text/x-red" data-help-name="delay">
<p>Introduces a delay into a flow or rate limits messages</p>
<p>Default delay is 5 seconds or rate limit of 1 message/second, but both can be configured</p>
<p>The rate limiter will delay messages by buffering in a time released queue. A warning is generated if the buffer is larger than 1000 items.</p>
2013-09-27 11:55:46 +02:00
</script>
<script type="text/javascript">
RED.nodes.registerType('delay',{
category: 'function',
2013-09-27 11:55:46 +02:00
color:"#E6E0F8",
defaults: {
name: {value:""},
2013-10-02 12:03:43 +02:00
pauseType: {value:"delay", required:true},
timeout: {value:"5", required:true, validate:RED.validators.number()},
timeoutUnits: {value:"seconds"},
rate: {value:"1", required:true, validate:RED.validators.number()},
rateUnits: {value: "second"}
2013-09-27 11:55:46 +02:00
},
inputs:1,
outputs:1,
icon: "timer.png",
label: function() {
2013-10-02 12:03:43 +02:00
if (this.pauseType == "delay") {
var units = this.timeoutUnits ? this.timeoutUnits.charAt(0) : "s";
return this.name||"delay "+this.timeout+" " + units;
2013-10-02 12:03:43 +02:00
} else if (this.pauseType == "rate") {
var units = this.rateUnits ? this.rateUnits.charAt(0) : "s";
return this.name||"limit "+this.rate+" msg/"+ units;
2013-10-02 12:03:43 +02:00
}
return "";
2013-09-27 11:55:46 +02:00
},
labelStyle: function() {
2013-09-27 11:55:46 +02:00
return this.name?"node_label_italic":"";
2013-10-02 12:03:43 +02:00
},
oneditprepare: function() {
$( "#node-input-timeout" ).spinner({ min:1, max:60 });
$( "#node-input-rate" ).spinner({ min:1});
2013-10-02 12:03:43 +02:00
if (this.pauseType == "delay") {
$("#delay-details").show();
$("#rate-details").hide();
} else if (this.pauseType == "rate") {
$("#delay-details").hide();
$("#rate-details").show();
}
if (!this.timeoutUnits) {
$("#node-input-timeoutUnits option").filter(function() {
return $(this).val() == 'seconds';
}).attr('selected', true);
}
2013-10-02 12:03:43 +02:00
$("#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();
}
2013-10-02 12:03:43 +02:00
});
2013-09-27 11:55:46 +02:00
}
});
</script>