allow setting read/write timeout

Author: keenanlang

docs/libraries/asyn-library.md

@@ -412,6 +412,28 @@ port.OutTerminator = "\r\n"
 print(port.OutTerminator)
 ```
 
+### client.ReadTimeout
+---
+
+Get or set the read timeout in seconds for this client. Used by
+`:read()` and `:writeread()`. Default is 1.0.
+
+```lua
+port.ReadTimeout = 5.0
+print(port.ReadTimeout)
+```
+
+### client.WriteTimeout
+---
+
+Get or set the write timeout in seconds for this client. Used by
+`:write()`. Default is 1.0.
+
+```lua
+port.WriteTimeout = 0.5
+print(port.WriteTimeout)
+```
+
 ### client[addr]
 ---
 

docs/libraries/bytestream-library.md

@@ -30,14 +30,6 @@ luaAddModule("$(LUA)")     -- from iocsh, or luaAddModule(LUA) from Lua
 local bs = require("bytestream")
 ```
 
-Dependencies (lpeg and asyn) are loaded lazily on first use -- requiring
-bytestream does not force asyn to load until a client is created.
-
-All functions that encounter errors raise them via `error()`. When used from
-DTYP "lua" device support, raised errors are caught by `lua_pcall` and mapped
-to record alarm states automatically.
-
-
 Format Specifiers
 -----------------
 
@@ -308,7 +300,7 @@ local val = dev:write("MEAS?"):read("%f")
 | ...         | varies | Values to format (only when using format mode). |
 
 The `OutTerminator` property is appended automatically by the underlying
-asyn port -- do not include terminators in the write data.
+asyn port.
 
 <br>
 
@@ -369,12 +361,15 @@ The following properties are delegated to the underlying `asyn.client`:
 | - | - | - |
 | `InTerminator` | string | Get or set the input end-of-string terminator. |
 | `OutTerminator` | string | Get or set the output end-of-string terminator. |
+| `ReadTimeout` | number | Get or set the read timeout in seconds (default 1.0). |
+| `WriteTimeout` | number | Get or set the write timeout in seconds (default 1.0). |
 | `portName` | string | Read-only. The port name this client is connected to. |
 | `addr` | number | Read-only. The address this client is connected to. |
 
 ```lua
 dev.OutTerminator = "\r\n"
 dev.InTerminator  = "\r\n"
+dev.ReadTimeout   = 5.0
 print(dev.portName)       -- "SERIAL1"
 ```
 

luaApp/src/libs/lasynlib.cpp

@@ -764,6 +764,8 @@ typedef struct {
 	asynOctetClient* client;
 	char portName[64];
 	int addr;
+	double readTimeout;
+	double writeTimeout;
 } ClientUD;
 
 static ClientUD* check_clientud(lua_State* state, int idx)
@@ -792,20 +794,23 @@ static void push_clientproxy(lua_State* state, const char* portName, int addr, c
 static int l_client_read(lua_State* state)
 {
 	ClientUD* ud = check_clientud(state, 1);
+	ud->client->setTimeout(ud->readTimeout);
 	return asyn_read(state, ud->client);
 }
 
 static int l_client_write(lua_State* state)
 {
 	ClientUD* ud = check_clientud(state, 1);
 	const char* data = luaL_checkstring(state, 2);
+	ud->client->setTimeout(ud->writeTimeout);
 	return asyn_write(state, ud->client, data, strlen(data));
 }
 
 static int l_client_writeread(lua_State* state)
 {
 	ClientUD* ud = check_clientud(state, 1);
 	const char* data = luaL_checkstring(state, 2);
+	ud->client->setTimeout(ud->readTimeout);
 	return asyn_writeread(state, ud->client, data, strlen(data));
 }
 
@@ -911,6 +916,10 @@ static int l_client_index(lua_State* state)
 	if (strcmp(key, "portName") == 0)   { lua_pushstring(state, ud->portName); return 1; }
 	if (strcmp(key, "addr") == 0)       { lua_pushinteger(state, ud->addr); return 1; }
 
+	/* Timeouts */
+	if (strcmp(key, "ReadTimeout") == 0)  { lua_pushnumber(state, ud->readTimeout); return 1; }
+	if (strcmp(key, "WriteTimeout") == 0) { lua_pushnumber(state, ud->writeTimeout); return 1; }
+
 	/* Terminators */
 	if (strcmp(key, "InTerminator") == 0)
 	{
@@ -948,6 +957,14 @@ static int l_client_newindex(lua_State* state)
 		const char* eos = lua_tostring(state, 3);
 		ud->client->setOutputEos(eos, strlen(eos));
 	}
+	else if (strcmp(key, "ReadTimeout") == 0)
+	{
+		ud->readTimeout = luaL_checknumber(state, 3);
+	}
+	else if (strcmp(key, "WriteTimeout") == 0)
+	{
+		ud->writeTimeout = luaL_checknumber(state, 3);
+	}
 
 	return 0;
 }
@@ -960,6 +977,8 @@ static void push_clientproxy(lua_State* state, const char* portName, int addr, c
 	strncpy(ud->portName, portName, sizeof(ud->portName) - 1);
 	ud->portName[sizeof(ud->portName) - 1] = '\0';
 	ud->addr = addr;
+	ud->readTimeout = DEFAULT_TIMEOUT;
+	ud->writeTimeout = DEFAULT_TIMEOUT;
 
 	{
 		char errbuf[256] = { '\0' };
@@ -997,14 +1016,16 @@ static void push_clientproxy(lua_State* state, const char* portName, int addr, c
 		lua_pushstring(state, ".addr                       -- address (property)"); lua_rawseti(state, -2, 2);
 		lua_pushstring(state, ".InTerminator               -- get/set input terminator"); lua_rawseti(state, -2, 3);
 		lua_pushstring(state, ".OutTerminator              -- get/set output terminator"); lua_rawseti(state, -2, 4);
-		lua_pushstring(state, ":read()"); lua_rawseti(state, -2, 5);
-		lua_pushstring(state, ":write(data)"); lua_rawseti(state, -2, 6);
-		lua_pushstring(state, ":writeread(data)"); lua_rawseti(state, -2, 7);
-		lua_pushstring(state, ":flush()"); lua_rawseti(state, -2, 8);
-		lua_pushstring(state, ":trace(mask) -- error=0x1, device=0x2, filter=0x4, driver=0x8, flow=0x10, warning=0x20"); lua_rawseti(state, -2, 9);
-		lua_pushstring(state, ":traceio(mask) -- nodata=0x0, ascii=0x1, escape=0x2, hex=0x4"); lua_rawseti(state, -2, 10);
-		lua_pushstring(state, ":setOption(key, val)"); lua_rawseti(state, -2, 11);
-		lua_pushstring(state, "[addr]                      -- index by address"); lua_rawseti(state, -2, 12);
+		lua_pushstring(state, ".ReadTimeout                -- get/set read timeout (seconds)"); lua_rawseti(state, -2, 5);
+		lua_pushstring(state, ".WriteTimeout               -- get/set write timeout (seconds)"); lua_rawseti(state, -2, 6);
+		lua_pushstring(state, ":read()"); lua_rawseti(state, -2, 7);
+		lua_pushstring(state, ":write(data)"); lua_rawseti(state, -2, 8);
+		lua_pushstring(state, ":writeread(data)"); lua_rawseti(state, -2, 9);
+		lua_pushstring(state, ":flush()"); lua_rawseti(state, -2, 10);
+		lua_pushstring(state, ":trace(mask) -- error=0x1, device=0x2, filter=0x4, driver=0x8, flow=0x10, warning=0x20"); lua_rawseti(state, -2, 11);
+		lua_pushstring(state, ":traceio(mask) -- nodata=0x0, ascii=0x1, escape=0x2, hex=0x4"); lua_rawseti(state, -2, 12);
+		lua_pushstring(state, ":setOption(key, val)"); lua_rawseti(state, -2, 13);
+		lua_pushstring(state, "[addr]                      -- index by address"); lua_rawseti(state, -2, 14);
 		lua_setfield(state, -2, "_doc");
 	}
 	lua_setmetatable(state, -2);