Zyre binding

.gitignore

@@ -0,0 +1,31 @@
+*~
+*.lo
+*.la
+
+build/
+.libs/
+autom4te.cache/
+modules/
+
+tests/*.diff
+tests/*.exp
+tests/*.log
+tests/*.out
+tests/*.php
+tests/*.sh
+
+Makefile*
+configure*
+libtool
+ltmain.sh
+missing
+mkinstalldirs
+install-sh
+aclocal.m4
+acinclude.m4
+.deps
+
+config*
+!config.m4
+!config.w32
+

.travis.yml

@@ -1,22 +1,17 @@
 language: php
+
 php:
-    - 5.6
     - 5.5
-    - 5.4
-    - 5.3
+
 env:
-    - ZEROMQ_VERSION=v2.2.0
-    - ZEROMQ_VERSION=v3.1.0
-    - ZEROMQ_VERSION=v3.2.0
-    - ZEROMQ_VERSION=v3.2.1
-    - ZEROMQ_VERSION=v3.2.2
-    - ZEROMQ_VERSION=v3.2.3
-    - ZEROMQ_VERSION=v3.2.4
-    - ZEROMQ_VERSION=v4.0.0
     - ZEROMQ_VERSION=v4.0.1
-
     - ZEROMQ_VERSION=v4.0.1 WITH_CZMQ=true
+    - ZEROMQ_VERSION=v4.0.1 WITH_CZMQ=true WITH_ZYRE=true
+
 before_install:
     - sudo apt-get update
+    - sudo apt-get remove libzmq3-dev libzmq3
     - sudo apt-get install uuid-dev
-script: travis/script.sh $ZEROMQ_VERSION $WITH_CZMQ
+
+script: travis/script.sh $ZEROMQ_VERSION $WITH_CZMQ $WITH_ZYRE
+

api.php

@@ -426,6 +426,91 @@ public function count() {}
     public function clear() {}
 }
 
+class ZMQZyre {
+    const LIBZYRE_VERSION = '1.1.0';
+	/**
+	 * Construct a ZMQZyre
+	 * 
+	 * @param ZMQContext $context
+	 * @return void
+	 */
+	public function __construct(ZMQContext $ZMQContext) {}
+	/**
+	 * Set node header; these are provided to other nodes during discovery and come in each ENTER message.
+	 * 
+	 * @param string $name
+	 * @param string $value
+	 * @return void
+	 */
+	public function setHeader($name, $value="") {}
+	/**
+	 * Start node, after setting header values. When you start a node it begins discovery and connection.
+	There is no stop method; to stop a node, destroy it.
+	 * 
+	 * @return void
+	 */
+	public function start() {}
+	/**
+	 * Stop node, this signals to other peers that this node will go away.
+	This is polite; however you can also just destroy the node without stopping it.
+	 * 
+	 * @return void
+	 */
+	public function stop() {}
+	/**
+	 * Join a named group; after joining a group you can send messages 
+	to the group and all Zyre nodes in that group will receive them.
+	 * 
+	 * @param string $group
+	 * @return void
+	 */
+	public function join($group) {}
+	/**
+	 * Leave a group.
+	 * 
+	 * @param string $group
+	 * @return void
+	 */
+	public function leave($group) {}
+	/**
+	 * Receive next message from network; the message may be a control 
+	message (ENTER, EXIT, JOIN, LEAVE) or data (WHISPER, SHOUT).
+	Returns associative array, or NULL if interrupted
+	 * 
+	 * @return void
+	 */
+	public function recv() {}
+	/**
+	 * Send a message on the network to a specific peer
+	 * 
+	 * @param string $peer
+	 * @param string $data
+	 * @return void
+	 */
+	public function sendPeer($peer, $data) {}
+	/**
+	 * Send a message on the network for a group
+	 * 
+	 * @param string $group
+	 * @param string $data
+	 * @return void
+	 */
+	public function sendGroup($group, $data) {}
+	/**
+	 * Get zyre ZeroMQ socket, for polling or receiving messages
+	 * 
+	 * @return ZMQSocket
+	 */
+	public function getSocket() {}
+}
+
+class ZMQException              extends Exception {}
+class ZMQContextException       extends ZMQException {}
+class ZMQSocketException        extends ZMQException {}
+class ZMQPollException          extends ZMQException {}
+class ZMQDeviceException        extends ZMQException {}
+class ZMQZyreException          extends ZMQException {}
+
 /**
  * A security certificate for the ØMQ CURVE authentication mechanism.
  */
@@ -665,5 +750,6 @@ public function deny($address) {}
      */
     public function configure($type, $domain, $filename) {}
 }
+
 ?>
 </code></pre>

config.m4

@@ -7,6 +7,9 @@ PHP_ARG_ENABLE(zmq_pthreads,    whether to enable support for php threads extens
 PHP_ARG_WITH(czmq,    whether to enable CZMQ support,
 [  --with-czmq[=DIR]  Enable CZMQ support. DIR is the prefix to CZMQ installation directory.], no, no)
 
+PHP_ARG_WITH(zyre,    whether to enable Zyre support,
+[  --with-zyre[=DIR]  Enable Zyre support. DIR is the prefix to Zyre installation directory.], no, no)
+
 if test "$PHP_ZMQ" != "no"; then
 
   AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
@@ -69,6 +72,29 @@ if test "$PHP_ZMQ" != "no"; then
     fi
   fi
 
+  if test "$PHP_ZYRE" != "no" -a "$PHP_CZMQ" != "no"; then
+    if test "x$PHP_ZYRE" != "xyes"; then
+      export PKG_CONFIG_PATH="${PHP_ZYRE}/${PHP_LIBDIR}/pkgconfig"
+    fi
+
+    AC_MSG_CHECKING(for Zyre)
+    if $PKG_CONFIG --exists libzyre; then
+      PHP_ZYRE_VERSION=`$PKG_CONFIG libzyre --modversion`
+      PHP_ZYRE_PREFIX=`$PKG_CONFIG libzyre --variable=prefix`
+      AC_MSG_RESULT([found version $PHP_ZYRE_VERSION in $PHP_ZYRE_PREFIX])
+
+      PHP_ZYRE_LIBS=`$PKG_CONFIG libzyre --libs`
+      PHP_ZYRE_INCS=`$PKG_CONFIG libzyre --cflags`
+
+      PHP_EVAL_LIBLINE($PHP_ZYRE_LIBS, ZMQ_SHARED_LIBADD)
+      PHP_EVAL_INCLINE($PHP_ZYRE_INCS)
+
+      AC_DEFINE([HAVE_ZYRE], [], [ZYRE was found])
+    else
+      AC_MSG_RESULT([no])
+    fi
+  fi
+
   AC_CHECK_HEADERS([stdint.h],[php_zmq_have_stdint=yes; break;])
   if test $php_zmq_have_stdint != "yes"; then
     AC_MSG_ERROR(Unable to find stdint.h)

package.xml

@@ -108,6 +108,15 @@
       <file name="rose.jpg" role="test" />
       <file name="skipif.inc" role="test" />
       <file name="zeromq_test_helper.inc" role="test" />
+
+      <!-- Zyre tests files -->
+      <file name="skipzyre.inc" role="test" />
+      <file name="zyre-001.phpt" role="test" />
+      <file name="zyre-002.phpt" role="test" />
+      <file name="zyre-003.phpt" role="test" />
+      <file name="zyre-004.phpt" role="test" />
+      <file name="zyre-005.phpt" role="test" />
+      <file name="zyre-006.phpt" role="test" />
    </dir>
   </dir>
  </contents>

php_zmq.h

@@ -47,4 +47,16 @@
 extern zend_module_entry zmq_module_entry;
 #define phpext_zmq_ptr &zmq_module_entry
 
+/* PHP 5.4 */
+#if PHP_VERSION_ID < 50399
+# define object_properties_init(zo, class_type) { \
+			zval *tmp; \
+			zend_hash_copy((*zo).properties, \
+							&class_type->default_properties, \
+							(copy_ctor_func_t) zval_add_ref, \
+							(void *) &tmp, \
+							sizeof(zval *)); \
+		 }
+#endif
+
 #endif /* _PHP_ZMQ_H_ */

php_zmq_private.h

@@ -44,6 +44,14 @@
 # endif
 #endif
 
+#if defined(HAVE_CZMQ) && defined(HAVE_ZYRE)
+# include <czmq.h>
+# include <zyre.h>
+# if ZYRE_VERSION_MAJOR == 1 && CZMQ_VERSION_MAJOR >= 2
+#  define HAVE_ZYRE_1
+# endif
+#endif
+
 #ifdef PHP_WIN32
 # include "win32/php_stdint.h"
 #else
@@ -275,6 +283,17 @@ ZEND_BEGIN_MODULE_GLOBALS(php_zmq)
 	php_zmq_clock_ctx_t *clock_ctx;
 ZEND_END_MODULE_GLOBALS(php_zmq)
 
+
+#ifdef HAVE_ZYRE_1
+#define PHP_ZMQ_ZYRE_OBJECT php_zmq_zyre *this = (php_zmq_zyre *)zend_object_store_get_object(getThis() TSRMLS_CC)
+typedef struct _php_zmq_zyre {
+	zend_object zend_object;
+	zctx_t *shadow_context;
+	zyre_t *zyre;
+	zval *internal_socket;
+} php_zmq_zyre;
+#endif
+
 #ifdef HAVE_CZMQ_2
 typedef struct _php_zmq_cert {
 	zend_object zend_object;

tests/skipzyre.inc

@@ -0,0 +1,6 @@
+<?php
+
+if (!extension_loaded("zmq")) die("skip");
+if (!class_exists('ZMQZyre')) die('skip');
+
+?>

tests/zyre-001.phpt

@@ -0,0 +1,15 @@
+--TEST--
+Test [Zyre] Object can be instancied multiple time
+--SKIPIF--
+<?php require_once(dirname(__FILE__) . '/skipzyre.inc'); ?>
+--FILE--
+<?php
+
+$ctx = new ZMQContext;
+$z1 = new ZMQZyre($ctx);
+$z2 = new ZMQZyre($ctx);
+$z3 = new ZMQZyre($ctx);
+echo "OK";
+
+--EXPECTF--
+OK

tests/zyre-002.phpt

@@ -0,0 +1,42 @@
+--TEST--
+Test [Zyre] Headers are received on ENTER event
+--SKIPIF--
+<?php require_once(dirname(__FILE__) . '/skipzyre.inc'); ?>
+--FILE--
+<?php
+
+$ctx = new ZMQContext;
+
+$z1 = new ZMQZyre($ctx);
+$z1->setHeader('X-TEST', 'Z1');
+$z1->start();
+
+$z2 = new ZMQZyre($ctx);
+$z2->setHeader('X-TEST', 'Z2');
+$z2->start();
+
+usleep(100000);
+
+$obj = $z1->recv();
+var_dump($obj->command);
+var_dump($obj->headers->{'X-TEST'});
+
+$obj = $z2->recv();
+var_dump($obj->command);
+var_dump($obj->headers->{'X-TEST'});
+
+$z1->stop();
+
+usleep(100000);
+
+$obj = $z2->recv();
+var_dump($obj->command);
+
+$z2->stop();
+
+--EXPECTF--
+string(5) "ENTER"
+string(2) "Z2"
+string(5) "ENTER"
+string(2) "Z1"
+string(4) "EXIT"