Permalink
Browse files

updated docs to reflect recent changes.

  • Loading branch information...
agentzh committed Feb 6, 2012
1 parent 1d7626f commit a8cad73ed968ae268d0baf6cb6221abc70f959e2
Showing with 18 additions and 4 deletions.
  1. +10 −2 README
  2. +4 −1 README.markdown
  3. +4 −1 doc/HttpLuaModule.wiki
View
12 README
@@ -8,8 +8,8 @@ Status
This module is under active development and is production ready.
Version
- This document describes ngx_lua v0.5.0rc2
- (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 5
+ This document describes ngx_lua v0.5.0rc3
+ (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 6
February 2012.
Synopsis
@@ -3298,6 +3298,12 @@ Nginx API for Lua
In case of success, it returns the total number of bytes that have been
sent. Otherwise, it returns "nil" and a string describing the error.
+ The input argument `data` can either be a Lua string or a (nested) Lua
+ table holding string fragments. In case of table arguments, this method
+ will automatically copy all the string elements piece by piece to the
+ underlying Nginx socket send buffers, which is usually optimal than
+ doing string concatenation operations on the Lua land.
+
Timeout for the sending operation is controlled by the
lua_socket_send_timeout config directive and the settimeout method. And
the latter takes priority. For example:
@@ -4033,6 +4039,8 @@ TODO
(<http://w3.impa.br/~diego/software/luasocket/udp.html>) in our
cosocket API.
+ * implement the "ngx.re.split" method.
+
* add configure options for different strategies of handling the
cosocket connection exceeding in the pools.
View
@@ -13,7 +13,7 @@ This module is under active development and is production ready.
Version
=======
-This document describes ngx_lua [v0.5.0rc2](https://github.com/chaoslawful/lua-nginx-module/tags) released on 5 February 2012.
+This document describes ngx_lua [v0.5.0rc3](https://github.com/chaoslawful/lua-nginx-module/tags) released on 6 February 2012.
Synopsis
========
@@ -3116,6 +3116,8 @@ This method is a synchronous operation that will not return until *all* the data
In case of success, it returns the total number of bytes that have been sent. Otherwise, it returns `nil` and a string describing the error.
+The input argument `data` can either be a Lua string or a (nested) Lua table holding string fragments. In case of table arguments, this method will automatically copy all the string elements piece by piece to the underlying Nginx socket send buffers, which is usually optimal than doing string concatenation operations on the Lua land.
+
Timeout for the sending operation is controlled by the [lua_socket_send_timeout](http://wiki.nginx.org/HttpLuaModule#lua_socket_send_timeout) config directive and the [settimeout](http://wiki.nginx.org/HttpLuaModule#tcpsock:settimeout) method. And the latter takes priority. For example:
@@ -3677,6 +3679,7 @@ Short Term
----------
* make [tcpsock:send](http://wiki.nginx.org/HttpLuaModule#tcpsock:send) method accept (nested) Lua tables of strings as its first argument to save string concatenation operations on the Lua user land.
* implement [LuaSocket UDP API](http://w3.impa.br/~diego/software/luasocket/udp.html) in our cosocket API.
+* implement the `ngx.re.split` method.
* add configure options for different strategies of handling the cosocket connection exceeding in the pools.
* add directives to run Lua codes when nginx stops/reloads.
* deal with TCP 3-second delay problem under great connection harness.
View
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
= Version =
-This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc2] released on 5 February 2012.
+This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc3] released on 6 February 2012.
= Synopsis =
<geshi lang="nginx">
@@ -3015,6 +3015,8 @@ This method is a synchronous operation that will not return until ''all'' the da
In case of success, it returns the total number of bytes that have been sent. Otherwise, it returns <code>nil</code> and a string describing the error.
+The input argument `data` can either be a Lua string or a (nested) Lua table holding string fragments. In case of table arguments, this method will automatically copy all the string elements piece by piece to the underlying Nginx socket send buffers, which is usually optimal than doing string concatenation operations on the Lua land.
+
Timeout for the sending operation is controlled by the [[#lua_socket_send_timeout|lua_socket_send_timeout]] config directive and the [[#tcpsock:settimeout|settimeout]] method. And the latter takes priority. For example:
<geshi lang="lua">
@@ -3553,6 +3555,7 @@ Please report bugs or submit patches by:
== Short Term ==
* make [[#tcpsock:send|tcpsock:send]] method accept (nested) Lua tables of strings as its first argument to save string concatenation operations on the Lua user land.
* implement [http://w3.impa.br/~diego/software/luasocket/udp.html LuaSocket UDP API] in our cosocket API.
+* implement the <code>ngx.re.split</code> method.
* add configure options for different strategies of handling the cosocket connection exceeding in the pools.
* add directives to run Lua codes when nginx stops/reloads.
* deal with TCP 3-second delay problem under great connection harness.

0 comments on commit a8cad73

Please sign in to comment.