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

clarify tcp node text re blank parameters.

This commit is contained in:
Dave Conway-Jones 2020-02-19 16:40:07 +00:00
parent e3dab3cf20
commit 5e892f222b
No known key found for this signature in database
GPG Key ID: 302A6725C594817F

View File

@ -14,14 +14,14 @@
limitations under the License. limitations under the License.
--> -->
<script type="text/x-red" data-help-name="tcp in"> <script type="text/html" data-help-name="tcp in">
<p>Provides a choice of TCP inputs. Can either connect to a remote TCP port, <p>Provides a choice of TCP inputs. Can either connect to a remote TCP port,
or accept incoming connections.</p> or accept incoming connections.</p>
<p><b>Note: </b>On some systems you may need root or administrator access <p><b>Note: </b>On some systems you may need root or administrator access
to access ports below 1024.</p> to access ports below 1024.</p>
</script> </script>
<script type="text/x-red" data-help-name="tcp out"> <script type="text/html" data-help-name="tcp out">
<p>Provides a choice of TCP outputs. Can either connect to a remote TCP port, <p>Provides a choice of TCP outputs. Can either connect to a remote TCP port,
accept incoming connections, or reply to messages received from a TCP In node.</p> accept incoming connections, or reply to messages received from a TCP In node.</p>
<p>Only the <code>msg.payload</code> is sent.</p> <p>Only the <code>msg.payload</code> is sent.</p>
@ -34,12 +34,12 @@
to access ports below 1024.</p> to access ports below 1024.</p>
</script> </script>
<script type="text/x-red" data-help-name="tcp request"> <script type="text/html" data-help-name="tcp request">
<p>A simple TCP request node - sends the <code>msg.payload</code> to a server tcp port and expects a response.</p> <p>A simple TCP request node - sends the <code>msg.payload</code> to a server tcp port and expects a response.</p>
<p>Connects, sends the "request", and reads the "response". It can either count a number of <p>Connects, sends the "request", and reads the "response". It can either count a number of
returned characters into a fixed buffer, match a specified character before returning, returned characters into a fixed buffer, match a specified character before returning,
wait a fixed timeout from first reply and then return, sit and wait for data, or send then close the connection wait a fixed timeout from first reply and then return, sit and wait for data, or send then close the connection
immediately, without waiting for a reply.</p> immediately, without waiting for a reply.</p>
<p>The response will be output in <code>msg.payload</code> as a buffer, so you may want to .toString() it.</p> <p>The response will be output in <code>msg.payload</code> as a buffer, so you may want to .toString() it.</p>
<p>If you leave tcp host or port blank they must be set by using the <code>msg.host</code> and <code>msg.port</code> properties.</p> <p>If you leave tcp host or port blank they must be set by using the <code>msg.host</code> and <code>msg.port</code> properties in every message sent to the node.</p>
</script> </script>