MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a few notes about UDP handling, fixes #1701

This commit is contained in:
Marcel Stör 2017-01-26 23:06:58 +01:00
parent a2db0c65af
commit f9c9eff720
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/en/modules/net.md
View File

@ -410,6 +410,14 @@ none
# net.udpsocket Module # net.udpsocket Module
Remember that in contrast to TCP [UDP](https://en.wikipedia.org/wiki/User_Datagram_Protocol) is connectionless. Therefore, there is a minor but natural mismatch as for TCP/UDP functions in this module. While you would call [net.createConnection()](#netcreateconnection) for TCP it is [net.createUDPSocket()](#netcreateudpsocket) for UDP.
Other points worth noting:
- UDP sockets do not have a connection callback for the [`listen`](#netudpsocketlisten) function.
- UDP sockets do not have a `connect` function. Remote IP and port thus need to be defined in [`send()`](#netudpsocketsend).
- UDP socket's `receive` callback receives port/ip after the `data` argument.
## net.udpsocket:close() ## net.udpsocket:close()
Closes UDP socket. Closes UDP socket.
@ -426,9 +434,10 @@ The syntax and functional similar to [`net.server:listen()`](#netserverlisten),
Register callback functions for specific events. Register callback functions for specific events.
The syntax and functional similar to [`net.socket:on()`](#netsocketon), only "received", "sent" and "dns" events are valid. The syntax and functional similar to [`net.socket:on()`](#netsocketon). However, only "received", "sent" and "dns" are supported events.
**`received` callback have `port` and `ip` after `data` argument.** !!! note
The `received` callback receives `port` and `ip` *after* the `data` argument.
## net.udpsocket:send() ## net.udpsocket:send()