Skip to content

Commit 34f8f27

Browse files
committed
updated docs to reflect recent changes.
1 parent cdcbef3 commit 34f8f27

File tree

3 files changed

+23
-12
lines changed

3 files changed

+23
-12
lines changed

README

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Status
88
This module is under active development and is production ready.
99

1010
Version
11-
This document describes ngx_lua v0.5.0rc6
12-
(<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 13
11+
This document describes ngx_lua v0.5.0rc14
12+
(<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 22
1313
February 2012.
1414

1515
Synopsis
@@ -55,7 +55,7 @@ Synopsis
5555
# MIME type determined by default_type:
5656
default_type 'text/plain';
5757

58-
content_by_lua "ngx.say('Hello,world!')"
58+
content_by_lua "ngx.say('Hello,world!')";
5959
}
6060

6161
location /nginx_var {
@@ -3547,9 +3547,10 @@ Nginx API for Lua
35473547
request it or the associated maximal idle timeout is expired.
35483548

35493549
The first optional argument, "timeout", can be used to specify the
3550-
maximal idle timeout for the current connection. If omitted, the default
3551-
setting in the lua_socket_keepalive_timeout config directive will be
3552-
used.
3550+
maximal idle timeout (in milliseconds) for the current connection. If
3551+
omitted, the default setting in the lua_socket_keepalive_timeout config
3552+
directive will be used. If the 0 value is given, then the timeout
3553+
interval is unlimited.
35533554

35543555
The second optional argument, "size", can be used to specify the maximal
35553556
number of connections allowed in the connection pool for the current
@@ -4478,6 +4479,12 @@ See Also
44784479
* lua-resty-redis (<http://github.com/agentzh/lua-resty-redis>)
44794480
library based on ngx_lua cosocket
44804481

4482+
* lua-resty-mysql (<http://github.com/agentzh/lua-resty-mysql>)
4483+
library based on ngx_lua cosocket
4484+
4485+
* lua-resty-upload (<http://github.com/agentzh/lua-resty-upload>)
4486+
library based on ngx_lua cosocket
4487+
44814488
* Routing requests to different MySQL queries based on URI arguments
44824489
(<http://openresty.org/#RoutingMySQLQueriesBasedOnURIArgs>)
44834490

README.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This module is under active development and is production ready.
1313
Version
1414
=======
1515

16-
This document describes ngx_lua [v0.5.0rc6](https://github.com/chaoslawful/lua-nginx-module/tags) released on 13 February 2012.
16+
This document describes ngx_lua [v0.5.0rc14](https://github.com/chaoslawful/lua-nginx-module/tags) released on 22 February 2012.
1717

1818
Synopsis
1919
========
@@ -60,7 +60,7 @@ Synopsis
6060
# MIME type determined by default_type:
6161
default_type 'text/plain';
6262

63-
content_by_lua "ngx.say('Hello,world!')"
63+
content_by_lua "ngx.say('Hello,world!')";
6464
}
6565

6666
location /nginx_var {
@@ -3309,7 +3309,7 @@ tcpsock:setkeepalive
33093309

33103310
Puts the current socket's connection into the cosocket built-in connection pool and keep it alive until other [connect](http://wiki.nginx.org/HttpLuaModule#tcpsock:connect) method calls request it or the associated maximal idle timeout is expired.
33113311

3312-
The first optional argument, `timeout`, can be used to specify the maximal idle timeout for the current connection. If omitted, the default setting in the [lua_socket_keepalive_timeout](http://wiki.nginx.org/HttpLuaModule#lua_socket_keepalive_timeout) config directive will be used.
3312+
The first optional argument, `timeout`, can be used to specify the maximal idle timeout (in milliseconds) for the current connection. If omitted, the default setting in the [lua_socket_keepalive_timeout](http://wiki.nginx.org/HttpLuaModule#lua_socket_keepalive_timeout) config directive will be used. If the `0` value is given, then the timeout interval is unlimited.
33133313

33143314
The second optional argument, `size`, can be used to specify the maximal number of connections allowed in the connection pool for the current server (i.e., the current host-port pair or the unix domain socket file path). Note that the size of the connection pool cannot be changed once the pool is created. When this argument is omitted, the default setting in the [lua_socket_pool_size](http://wiki.nginx.org/HttpLuaModule#lua_socket_pool_size) config directive will be used.
33153315

@@ -3878,6 +3878,8 @@ See Also
38783878

38793879
* [lua-resty-memcached](http://github.com/agentzh/lua-resty-memcached) library based on ngx_lua cosocket
38803880
* [lua-resty-redis](http://github.com/agentzh/lua-resty-redis) library based on ngx_lua cosocket
3881+
* [lua-resty-mysql](http://github.com/agentzh/lua-resty-mysql) library based on ngx_lua cosocket
3882+
* [lua-resty-upload](http://github.com/agentzh/lua-resty-upload) library based on ngx_lua cosocket
38813883
* [Routing requests to different MySQL queries based on URI arguments](http://openresty.org/#RoutingMySQLQueriesBasedOnURIArgs)
38823884
* [Dynamic Routing Based on Redis and Lua](http://openresty.org/#DynamicRoutingBasedOnRedis)
38833885
* [Using LuaRocks with ngx_lua](http://openresty.org/#UsingLuaRocks)

doc/HttpLuaModule.wiki

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
1010

1111
= Version =
1212

13-
This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc6] released on 13 February 2012.
13+
This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc14] released on 22 February 2012.
1414

1515
= Synopsis =
1616
<geshi lang="nginx">
@@ -56,7 +56,7 @@ This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module
5656
# MIME type determined by default_type:
5757
default_type 'text/plain';
5858
59-
content_by_lua "ngx.say('Hello,world!')"
59+
content_by_lua "ngx.say('Hello,world!')";
6060
}
6161
6262
location /nginx_var {
@@ -3201,7 +3201,7 @@ This feature was first introduced in the <code>v0.5.0rc1</code> release.
32013201
32023202
Puts the current socket's connection into the cosocket built-in connection pool and keep it alive until other [[#tcpsock:connect|connect]] method calls request it or the associated maximal idle timeout is expired.
32033203
3204-
The first optional argument, <code>timeout</code>, can be used to specify the maximal idle timeout for the current connection. If omitted, the default setting in the [[#lua_socket_keepalive_timeout|lua_socket_keepalive_timeout]] config directive will be used.
3204+
The first optional argument, <code>timeout</code>, can be used to specify the maximal idle timeout (in milliseconds) for the current connection. If omitted, the default setting in the [[#lua_socket_keepalive_timeout|lua_socket_keepalive_timeout]] config directive will be used. If the <code>0</code> value is given, then the timeout interval is unlimited.
32053205
32063206
The second optional argument, <code>size</code>, can be used to specify the maximal number of connections allowed in the connection pool for the current server (i.e., the current host-port pair or the unix domain socket file path). Note that the size of the connection pool cannot be changed once the pool is created. When this argument is omitted, the default setting in the [[#lua_socket_pool_size|lua_socket_pool_size]] config directive will be used.
32073207
@@ -3745,6 +3745,8 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
37453745
37463746
* [http://github.com/agentzh/lua-resty-memcached lua-resty-memcached] library based on ngx_lua cosocket
37473747
* [http://github.com/agentzh/lua-resty-redis lua-resty-redis] library based on ngx_lua cosocket
3748+
* [http://github.com/agentzh/lua-resty-mysql lua-resty-mysql] library based on ngx_lua cosocket
3749+
* [http://github.com/agentzh/lua-resty-upload lua-resty-upload] library based on ngx_lua cosocket
37483750
* [http://openresty.org/#RoutingMySQLQueriesBasedOnURIArgs Routing requests to different MySQL queries based on URI arguments]
37493751
* [http://openresty.org/#DynamicRoutingBasedOnRedis Dynamic Routing Based on Redis and Lua]
37503752
* [http://openresty.org/#UsingLuaRocks Using LuaRocks with ngx_lua]

0 commit comments

Comments
 (0)