From 466c03d90fb0618488e9e790200777ed52c83ad2 Mon Sep 17 00:00:00 2001 From: Yury Popov Date: Tue, 7 Mar 2017 22:50:32 +0300 Subject: [PATCH] Deprecation messages for convenient net.create(Server/Connection) calls (#1844) --- app/modules/net.c | 11 +++++++++-- docs/en/modules/net.md | 12 ++++++------ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/app/modules/net.c b/app/modules/net.c index 7203d277..4a3c65cc 100644 --- a/app/modules/net.c +++ b/app/modules/net.c @@ -297,7 +297,10 @@ int net_createServer( lua_State *L ) { type = luaL_optlong(L, 1, TYPE_TCP); 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"); 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); 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 (secure) { + platform_print_deprecation_note("net.createConnection with secure flag", "in next version"); #ifdef TLS_MODULE_PRESENT return tls_socket_create( L ); #else diff --git a/docs/en/modules/net.md b/docs/en/modules/net.md index 67e0fa11..ec95d6bd 100644 --- a/docs/en/modules/net.md +++ b/docs/en/modules/net.md @@ -13,11 +13,11 @@ Constants to be used in other functions: `net.TCP`, `net.UDP` Creates a client. #### Syntax -`net.createConnection(type, secure)` +`net.createConnection([type[, secure]])` #### Parameters -- `type` `net.TCP` or `net.UDP`. UDP connections chained to [net.createUDPSocket()](#netcreateudpsocket) -- `secure` 1 for encrypted, 0 for plain. Secure connections chained to [tls.createConnection()](tls.md#tlscreateconnection) +- `type` `net.TCP` (default) or `net.UDP` +- `secure` 1 for encrypted, 0 for plain (default) !!! attention 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. #### Syntax -`net.createServer(type, timeout)` +`net.createServer([type[, timeout]])` #### Parameters -- `type` `net.TCP` or `net.UDP`. UDP connections chained to [net.createUDPSocket()](#netcreateudpsocket) -- `timeout` for a TCP server timeout is 1~28'800 seconds (for an inactive client to be disconnected) +- `type` `net.TCP` (default) or `net.UDP` +- `timeout` for a TCP server timeout is 1~28'800 seconds, 30 sec by default (for an inactive client to be disconnected) !!! 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.