feature: ngx.balancer: added new API functions set_timeouts() for setting per-session connect/send/read timeouts for the current upstream request and subsequent retries. thanks Jianhao Dai for the patch in openresty#30.

Author: agentzh

.travis.yml

@@ -47,6 +47,7 @@ install:
  - git clone https://github.com/openresty/lua-resty-lrucache.git
  - git clone https://github.com/openresty/headers-more-nginx-module.git ../headers-more-nginx-module
  - git clone -b v2.1-agentzh https://github.com/openresty/luajit2.git
+ - git clone https://github.com/openresty/mockeagain.git
 
 script:
  - cd luajit2/
@@ -59,8 +60,11 @@ script:
  - ./config shared --prefix=$OPENSSL_PREFIX -DPURIFY > build.log 2>&1 || (cat build.log && exit 1)
  - make -j$JOBS > build.log 2>&1 || (cat build.log && exit 1)
  - sudo make PATH=$PATH install_sw > build.log 2>&1 || (cat build.log && exit 1)
- - cd ..
+ - cd ../mockeagain/ && make CC=$CC -j$JOBS && cd ..
  - export PATH=$PWD/work/nginx/sbin:$PWD/nginx-devel-utils:$PATH
+ - export LD_PRELOAD=$PWD/mockeagain/mockeagain.so
+ - export LD_LIBRARY_PATH=$PWD/mockeagain:$LD_LIBRARY_PATH
+ - export TEST_NGINX_RESOLVER=8.8.4.4
  - export NGX_BUILD_CC=$CC
  - ngx-build $NGINX_VERSION --with-ipv6 --with-http_realip_module --with-http_ssl_module --with-cc-opt="-I$OPENSSL_INC" --with-ld-opt="-L$OPENSSL_LIB -Wl,-rpath,$OPENSSL_LIB" --add-module=../ndk-nginx-module --add-module=../echo-nginx-module --add-module=../headers-more-nginx-module --add-module=../lua-nginx-module --with-debug > build.log 2>&1 || (cat build.log && exit 1)
  - nginx -V

lib/ngx/balancer.lua

@@ -26,6 +26,10 @@ int ngx_http_lua_ffi_balancer_set_more_tries(ngx_http_request_t *r,
 
 int ngx_http_lua_ffi_balancer_get_last_failure(ngx_http_request_t *r,
  int *status, char **err);
+
+int ngx_http_lua_ffi_balancer_set_timeouts(ngx_http_request_t *r,
+ long connect_timeout, long send_timeout,
+ long read_timeout, char **err);
 ]]
 
 
@@ -101,4 +105,41 @@ function _M.get_last_failure()
 end
 
 
+function _M.set_timeouts(connect_timeout, send_timeout, read_timeout)
+ local r = getfenv(0).__ngx_req
+ if not r then
+ return error("no request found")
+ end
+
+ if not connect_timeout then
+ connect_timeout = 0
+ elseif type(connect_timeout) ~= "number" or connect_timeout <= 0 then
+ return error("bad connect timeout")
+ end
+
+ if not send_timeout then
+ send_timeout = 0
+ elseif type(send_timeout) ~= "number" or send_timeout <= 0 then
+ return error("bad send timeout")
+ end
+
+ if not read_timeout then
+ read_timeout = 0
+ elseif type(read_timeout) ~= "number" or read_timeout <= 0 then
+ return error("bad read timeout")
+ end
+
+ local rc =
+ C.ngx_http_lua_ffi_balancer_set_timeouts(r, connect_timeout,
+ send_timeout, read_timeout,
+ errmsg)
+
+ if rc == FFI_OK then
+ return true
+ end
+
+ return false, ffi_str(errmsg[0])
+end
+
+
 return _M

lib/ngx/balancer.md

@@ -14,6 +14,7 @@ Table of Contents
  * [set_current_peer](#set_current_peer)
  * [set_more_tries](#set_more_tries)
  * [get_last_failure](#get_last_failure)
+ * [set_timeouts](#set_timeouts)
 * [Community](#community)
  * [English Mailing List](#english-mailing-list)
  * [Chinese Mailing List](#chinese-mailing-list)
@@ -156,6 +157,31 @@ method always returns a single `nil` value.
 
 [Back to TOC](#table-of-contents)
 
+set_timeouts
+------------
+**syntax:** `ok, err = balancer.set_timeouts(connect_timeout, send_timeout, read_timeout)`
+
+**context:** *balancer_by_lua**
+
+Sets the upstream timeout (connect, send and read) in milliseconds for the current and any
+subsequent backend requests (which might be a retry).
+
+If you want to inherit the timeout value of the global `nginx.conf` configuration (like `proxy_connect_timeout`), then
+just specify the `nil` value for the corresponding argument (like the `connect_timeout` argument).
+
+Zero and negative timeout values are not allowed.
+
+Returns `true` when the operation is successul; returns `nil` and a string describing the error
+otherwise.
+
+This only affects the current downstream request. It is not a global change.
+
+For the best performance, you should use the [OpenResty](https://openresty.org/) bundle.
+
+This function was first added in the `0.1.7` version of this library.
+
+[Back to TOC](#table-of-contents)
+
 Community
 =========