frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Add websocket node docs

Browse Source 
Part of #105
This commit is contained in:
Nicholas O'Leary 2013-12-08 20:41:57 +00:00
parent cce5f33a97
commit 3984b6b702
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
nodes/core/io/22-websocket.html
View File

@ -27,8 +27,10 @@
</script> </script>
<script type="text/x-red" data-help-name="websocket in"> <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>WebSocket input node.</p>
<p>Outputs an object called <b>msg</b> containing <b>msg.payload</b>.</p> <p>By default, the data received from the WebSocket will be in <b>msg.payload</b>.
The listener can be configured to expect a properly formed JSON string, in which
case it will parse the JSON and send on the resulting object as the entire message.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
@ -65,7 +67,16 @@
</script> </script>
<script type="text/x-red" data-help-name="websocket out"> <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> <p>WebSocket out node.</p>
<p>By default, <b>msg.payload</b> will be sent over the WebSocket. The listener
can be configured to encode the entire message object as a JSON string and send that
over the WebSocket.</p>
<p>If the message arriving at this node started at a WebSocket In node, the message
will be sent back to the client that triggered the flow. Otherwise, the message
will be broadcast to all conntected clients.</p>
<p>If you want to broadcast a message that started at a WebSocket In node, you
should delete the <b>msg._session</b> property within the flow</p>.
</script> </script>
<script type="text/javascript"> <script type="text/javascript">