Merge pull request #1 from miurahr/tirex-socket-fix

Tirex socket fix and performance imrovement.

Author: miurahr

README.md

@@ -6,7 +6,8 @@ lua-nginx-osm - Lua Tirex client driver for the ngx_lua based on the cosocket AP
 Status
 ======
 
-This library is considered experimental status.
+Current version is 0.20, 3, June, 2013.
+This library is considered active development status.
 
 Description
 ===========
@@ -21,14 +22,18 @@ This Lua library takes advantage of ngx_lua's cosocket API, which ensures
 It also includes utility to handle metatile, URIs in Lua language.
 These utility is not depend on nginx, means pure lua implementation.
 
-Note that at least [ngx_lua 0.8.1](https://github.com/chaoslawful/lua-nginx-module/tags) is required.
+Note that at least [ngx_lua 0.7.20](https://github.com/chaoslawful/lua-nginx-module/tags) is required 
+and tested on [ngx_lua 0.8.1](https://github.com/chaoslawful/lua-nginx-module/tags).
+
+If you use Ubuntu Linux 12.04 (LTS) and after, there is a PPA(private package archive) for you.
+http://launchpad.net/~osmjapan/ppa
+Please see the above page for detail instructions.
 
 Synopsis
 ========
 
     lua_package_path "/path/to/lua-nginx-osm/?.lua;;";
     lua_shared_dict osm_tirex 10m; ## mandatory to use osm.tirex module
-    lua_socket_log_errors off;
 
     server {
         location /example {
@@ -166,6 +171,35 @@ send_request
 Request enqueue command to rendering map 'map' with x/y/z cordination.
 If request fails return nil.
 
+It is obsolete (0.10) interface.
+
+enqueue_request
+-------------
+
+**syntax:** *result = osm.tirex.enqueue_request(map, x, y, z, priority)*
+
+Request enqueue command to rendering map 'map' with x/y/z cordination and 
+priority.
+If request fails return nil.
+
+
+dequeue_request
+-------------
+
+**syntax:** *result = osm.tirex.dequeue_request(map, x, y, z, priority)*
+
+Request dequeue command to rendering map 'map' with x/y/z cordination and 
+priority.
+If request fails return nil.
+
+
+ping_request
+-------------
+
+**syntax:** *result = osm.tirex.ping_request()*
+
+Request ping command. If request fails return nil.
+
 
 TODO
 ====
@@ -206,6 +240,13 @@ Please report bugs or submit patches by
 
 1. creating a ticket on the [GitHub Issue Tracker](http://github.com/miurahr/lua-nginx-osm/issues),
 
+1. There are known problem that Tirex cannot response properly so we need to patch to tirex.
+
+  https://trac.openstreetmap.org/ticket/4869
+  
+  If you use Tirex 0.4.1(original)  or  tirex-0.4.1ppa4 and below, you need to patch to tirex.
+  Here is a patch file in misc/tirex-peer.diff.
+
 Author
 ======
 
@@ -215,8 +256,9 @@ Copyright and License
 =====================
 
 Hiroshi Miura, 2013 
+OpenStreetMap Foundation Japan, 2013
 
-Distributed under GPLv3
+Distributed under GPLv3 License.
 
 See Also
 ========

debian/backup

@@ -1,3 +1,16 @@
+lua-nginx-osm (0.20-1) precise; urgency=low
+
+  * New version: fix tirex socket problem.
+
+ -- Hiroshi Miura <[email protected]>  Sun, 02 Jun 2013 17:35:25 +0900
+
+lua-nginx-osm (0.19-1) precise; urgency=low
+
+  * remove Tirex buf workaround
+  * test for 0.20 version
+
+ -- Hiroshi Miura <[email protected]>  Sun, 02 Jun 2013 14:46:07 +0900
+
 lua-nginx-osm (0.10-2) precise; urgency=low
 
   * Add tirex dependency

debian/changelog

@@ -0,0 +1,31 @@
+diff --git a/lib/Tirex/Source/Command.pm b/lib/Tirex/Source/Command.pm
+index a653af4..b00d95f 100644
+--- a/lib/Tirex/Source/Command.pm
++++ b/lib/Tirex/Source/Command.pm
+@@ -10,6 +10,7 @@ use warnings;
+ use Carp;
+ 
+ use IO::Socket;
++use IO::Socket::UNIX;
+ 
+ #-----------------------------------------------------------------------------
+ package Tirex::Source::Command;
+@@ -53,6 +54,7 @@ sub readable
+ 
+     my $buf;
+     my $peer = $sock->recv($buf, $Tirex::MAX_PACKET_SIZE);
++    $self->{'peer'} = $peer;
+     my $args = Tirex::parse_msg($buf);
+ 
+     foreach (keys %$args) { $self->{$_} = $args->{$_}; };
+@@ -162,8 +164,9 @@ sub reply
+     my $msg  = shift;
+ 
+     $msg->{'id'} = $self->{'id'} if (defined $self->{'id'});
++    my $peer = $self->{'peer'};
+ 
+-    return $self->{'socket'}->send( Tirex::create_msg($msg) );
++    return $self->{'socket'}->send( Tirex::create_msg($msg), 0, $peer );
+ }
+ 
+ sub name