Commit b735fe7c authored by Marcel Stör's avatar Marcel Stör
Browse files

Merge pull request #1208 from devsaurus/net_hold

Document net.socket:hold() and unhold()
parents e5b30a42 2e1ecc19
......@@ -168,6 +168,22 @@ sk = nil
#### See also
[`net.createServer()`](#netcreateserver)
## net.socket:hold()
Throttle data reception by placing a request to block the TCP receive function. This request is not effective immediately, Espressif recommends to call it while reserving 5*1460 bytes of memory.
#### Syntax
`hold()`
#### Parameters
none
#### Returns
`nil`
#### See also
[`net.socket:unhold()`](#netsocketunhold)
## net.socket:on()
Register callback functions for specific events.
......@@ -194,7 +210,8 @@ end)
```
#### See also
[`net.createServer()`](#netcreateserver)
- [`net.createServer()`](#netcreateserver)
- [`net.socket:hold()`](#netsockethold)
## net.socket:send()
......@@ -263,6 +280,22 @@ end)
#### See also
[`net.socket:on()`](#netsocketon)
## net.socket:unhold()
Unblock TCP receiving data, i.e. undo `hold()`.
#### Syntax
`unhold()`
#### Parameters
none
#### Returns
`nil`
#### See also
[`net.socket:hold()`](#netsockethold)
# net.dns Module
## net.dns.getdnsserver()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment