node-red/nodes/io/31-tcpin.html

<!--
  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="tcp in">
    <div class="form-row">
        <label for="node-input-host"><i class="icon-bookmark"></i> Host</label>
        <input type="text" id="node-input-host" placeholder="localhost" style="width: 40%;" >

        <label for="node-input-port" style="margin-left: 10px; width: 35px;"> Port</label>
        <input type="text" id="node-input-port" placeholder="Port" style="width: 45px">
    </div>
    <div class="form-row">
        <label>&nbsp;</label>
        <input type="checkbox" id="node-input-server" placeholder="server" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-server" style="width: 70%;">Be a server socket ?</label>
    </div>
    <div class="form-row">
        <label>&nbsp;</label>
        <input type="checkbox" id="node-input-base64" placeholder="base64" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-base64" style="width: 70%;">Base64 encode payload ?</label>
    </div>
    <div class="form-row">
        <label for="node-input-topic"><i class="icon-tasks"></i> Topic</label>
        <input type="text" id="node-input-topic" placeholder="Topic">
    </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>
    <div class="form-tips">Tip: sends the received data as a Buffer object (not a String).<br/>If you select server socket the host defaults to localhost.</div>
</script>

<script type="text/x-red" data-help-name="tcp in">
	<p>Provides a choice of tcp input connections. Can either be a client - or provide a listening socket.</p>
	<p>The TCP node produces a <i>BUFFER</i> object <b></b>msg.payload</b> and NOT a String. If you need a String then use <i>.toString()</i> on <b>msg.payload</b> in your next function block.</p>
	<p>It also provides <b>msg.fromip</b> of the form ipaddress:port .</p>
	<p>You can select Base64 encoding if you want to make it easy to preserve the complete message as a string.</p>
	<p>In case of disconnection the client trys to reconnect every 10 secs. Topic is optional.</p>
</script>

<script type="text/javascript">
    RED.nodes.registerType('tcp in',{
        category: 'input',
        color:"Silver",
        defaults: {
            host: {value:"127.0.0.1",required:true},
            port: {value:"",required:true,validate:RED.validators.number()},
            base64: {value:false,required:true},
            server: {value:false,required:true},
            topic: {value:""},
            name: {value:""}
        },
        inputs:0,
        outputs:1,
        icon: "bridge-dash.png",
        label: function() {
			if ((this.host!="") & (this.port!="")) {
				return this.name||(this.host+":"+this.port);
			}
			else { return "tcp in"; }
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        }
    });
</script>