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

Deprecation messages for convenient net.create(Server/Connection) calls (#1844)

This commit is contained in:
Yury Popov 2017-03-07 22:50:32 +03:00 committed by Arnim Läuger
parent 4acabab1cc
commit 466c03d90f
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
app/modules/net.c
View File

@ -297,7 +297,10 @@ int net_createServer( lua_State *L ) {
type = luaL_optlong(L, 1, TYPE_TCP); type = luaL_optlong(L, 1, TYPE_TCP);
timeout = luaL_optlong(L, 2, 30); timeout = luaL_optlong(L, 2, 30);
if (type == TYPE_UDP) return net_createUDPSocket( L ); if (type == TYPE_UDP) {
platform_print_deprecation_note("net.createServer with net.UDP type", "in next version");
return net_createUDPSocket( L );
}
if (type != TYPE_TCP) return luaL_error(L, "invalid type"); if (type != TYPE_TCP) return luaL_error(L, "invalid type");
lnet_userdata *u = net_create(L, TYPE_TCP_SERVER); lnet_userdata *u = net_create(L, TYPE_TCP_SERVER);
@ -312,9 +315,13 @@ int net_createConnection( lua_State *L ) {
type = luaL_optlong(L, 1, TYPE_TCP); type = luaL_optlong(L, 1, TYPE_TCP);
secure = luaL_optlong(L, 2, 0); secure = luaL_optlong(L, 2, 0);
if (type == TYPE_UDP) return net_createUDPSocket( L ); if (type == TYPE_UDP) {
platform_print_deprecation_note("net.createConnection with net.UDP type", "in next version");
return net_createUDPSocket( L );
}
if (type != TYPE_TCP) return luaL_error(L, "invalid type"); if (type != TYPE_TCP) return luaL_error(L, "invalid type");
if (secure) { if (secure) {
platform_print_deprecation_note("net.createConnection with secure flag", "in next version");
#ifdef TLS_MODULE_PRESENT #ifdef TLS_MODULE_PRESENT
return tls_socket_create( L ); return tls_socket_create( L );
#else #else

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

@ -13,11 +13,11 @@ Constants to be used in other functions: `net.TCP`, `net.UDP`
Creates a client. Creates a client.
#### Syntax #### Syntax
`net.createConnection(type, secure)` `net.createConnection([type[, secure]])`
#### Parameters #### Parameters
- `type` `net.TCP` or `net.UDP`. UDP connections chained to [net.createUDPSocket()](#netcreateudpsocket) - `type` `net.TCP` (default) or `net.UDP`
- `secure` 1 for encrypted, 0 for plain. Secure connections chained to [tls.createConnection()](tls.md#tlscreateconnection) - `secure` 1 for encrypted, 0 for plain (default)
!!! attention !!! attention
This will change in upcoming releases so that `net.createConnection` will always create an unencrypted TCP connection. This will change in upcoming releases so that `net.createConnection` will always create an unencrypted TCP connection.
@ -44,11 +44,11 @@ net.createConnection(net.TCP, 0)
Creates a server. Creates a server.
#### Syntax #### Syntax
`net.createServer(type, timeout)` `net.createServer([type[, timeout]])`
#### Parameters #### Parameters
- `type` `net.TCP` or `net.UDP`. UDP connections chained to [net.createUDPSocket()](#netcreateudpsocket) - `type` `net.TCP` (default) or `net.UDP`
- `timeout` for a TCP server timeout is 1~28'800 seconds (for an inactive client to be disconnected) - `timeout` for a TCP server timeout is 1~28'800 seconds, 30 sec by default (for an inactive client to be disconnected)
!!! attention !!! attention
The `type` parameter will be removed in upcoming releases so that `net.createServer` will always create a TCP-based server. For UDP use [net.createUDPSocket()](#netcreateudpsocket) instead. The `type` parameter will be removed in upcoming releases so that `net.createServer` will always create a TCP-based server. For UDP use [net.createUDPSocket()](#netcreateudpsocket) instead.