Finalized v1.0

Author: KritzelKratzel

README.md

@@ -1,5 +1,5 @@
 # luaping
-The missing ping command for Lua - implemented in C for Windows.
+The missing ping command for Lua - currently implemented in C for Windows platforms.
 
 ## Build for OneLuaPro
 
@@ -26,3 +26,40 @@ local result, errmsg = p.settimeout(50)		-- sets timeout to 50ms
 -- If result == false, errmsg provides error info, else errmsg = nil
 ```
 
+## Testbench
+
+```cmd
+C:\misc\luaping\test>lua tb.lua
+Version info:   luaping 1.0
+
+Testing malformed IP address, must return false + errmsg:
+Testing         xxx.xxx.xxx.xxx :       false   Argument is not an IP address.
+Testing         12345678        :       false   Call to IcmpSendEcho failed.
+Testing         localhost       :       false   Argument is not an IP address.
+
+Testing 127.0.0.1, must return true + nil:
+Testing         127.0.0.1       :       true    nil
+
+Testing valid but unreachable IP address, must return false + errmsg:
+Note: runtime measurement below 1000ms is not vey exact.
+Timeout set to  50      ms.
+   Testing      192.168.99.99   :       false   Call to IcmpSendEcho failed.
+   Runtime :    63      ms.
+Timeout set to  100     ms.
+   Testing      192.168.99.99   :       false   Call to IcmpSendEcho failed.
+   Runtime :    499     ms.
+Timeout set to  1000    ms.
+   Testing      192.168.99.99   :       false   Call to IcmpSendEcho failed.
+   Runtime :    999     ms.
+Timeout set to  5000    ms.
+   Testing      192.168.99.99   :       false   Call to IcmpSendEcho failed.
+   Runtime :    5000    ms.
+Timeout set to  10000   ms.
+   Testing      192.168.99.99   :       false   Call to IcmpSendEcho failed.
+   Runtime :    10000   ms.
+
+End of testbench.
+
+C:\misc\luaping\test>
+```
+

src/luaping.c

@@ -41,8 +41,10 @@ Code heavily insprired by lsleep library (https://github.com/andrewstarks/lsleep
 
 #define TRUE 1
 #define FALSE 0
+#define LUAPING_VERSION "luaping 1.0"
 
 // Globals
+// https://stackoverflow.com/questions/75701
 DWORD timeout = 1000;	// in milliseconds
 
 #ifdef _WINDLL
@@ -204,7 +206,7 @@ static int luaping_ping(lua_State *L) {
   return 2;
 }
 #else
-// FIXME - non-Win not yet implemented
+// FIXME - non-_WINDLL not yet implemented
 #endif
 
 static const struct luaL_Reg luaping_metamethods [] = {
@@ -225,5 +227,7 @@ DLL int luaopen_luaping(lua_State *L){
   luaL_newlib(L, luaping_funcs);
   luaL_newlib(L, luaping_metamethods);
   lua_setmetatable(L, -2);
+  lua_pushliteral(L,LUAPING_VERSION);
+  lua_setfield(L,-2,"_VERSION");
   return 1;
 }

test/tb.lua

@@ -0,0 +1,35 @@
+-- luaping test bench
+local lp = require "luaping"
+local socket = require "socket"
+
+print("Version info: ",lp._VERSION)
+print()
+
+print("Testing malformed IP address, must return false + errmsg:")
+local stuff0 = {"xxx.xxx.xxx.xxx",12345678,"localhost"}
+for i,v in ipairs(stuff0) do
+   print("Testing ",v,":", lp.ping(v))
+end
+print()
+
+print("Testing 127.0.0.1, must return true + nil:")
+local lh="127.0.0.1"
+print("Testing ",lh,":", lp.ping(lh))
+print()
+
+print("Testing valid but unreachable IP address, must return false + errmsg:")
+print("Note: runtime measurement below 1000ms is not vey exact.")
+local ur = "192.168.99.99" 	-- may vary
+local timeouts = {50, 100, 1000, 5000, 10000}	-- in milliseconds
+for _,v in ipairs(timeouts) do
+   lp.settimeout(v)
+   print("Timeout set to",lp.timeout(),"ms.")
+   local startTime = socket.gettime()*1000        -- milliseconds
+   print("   Testing ",ur,":", lp.ping(ur))
+   local stopTime = socket.gettime()*1000        -- milliseconds
+   print("   Runtime :",math.floor(stopTime-startTime),"ms.")
+end
+print()
+
+print("End of testbench.")
+os.exit(0)