Zyre binding

api.php

@@ -374,5 +374,89 @@ public function count() {}
      */
     public function clear() {}
 }
+
+class ZMQZyre {
+	/**
+	 * 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 {}
 ?>
-</code></pre>
+</code></pre>

config.m4

@@ -43,6 +43,40 @@ if test "$PHP_ZMQ" != "no"; then
     AC_MSG_ERROR(Unable to find libzmq installation)
   fi
 
+  AC_MSG_CHECKING(for CZMQ)
+  if $PKG_CONFIG --exists libczmq; then
+    PHP_CZMQ_VERSION=`$PKG_CONFIG libczmq --modversion`
+    PHP_CZMQ_PREFIX=`$PKG_CONFIG libczmq --variable=prefix`
+    AC_MSG_RESULT([found version $PHP_CZMQ_VERSION in $PHP_CZMQ_PREFIX])
+
+    PHP_CZMQ_LIBS=`$PKG_CONFIG libczmq --libs`
+    PHP_CZMQ_INCS=`$PKG_CONFIG libczmq --cflags`
+
+    PHP_EVAL_LIBLINE($PHP_CZMQ_LIBS, ZMQ_SHARED_LIBADD)
+    PHP_EVAL_INCLINE($PHP_CZMQ_INCS)
+
+    AC_DEFINE([HAVE_CZMQ], [], [CZMQ was found])
+  else
+    AC_MSG_RESULT([no])
+  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
+
   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)

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

@@ -37,6 +37,14 @@
 
 #include <zmq.h>
 
+#ifdef HAVE_CZMQ && HAVE_ZYRE
+# include <czmq.h>
+# include <zyre.h>
+# if ZYRE_VERSION_MAJOR == 1
+#  define HAVE_ZYRE_1
+# endif
+#endif
+
 #ifdef PHP_WIN32
 # include "win32/php_stdint.h"
 #else
@@ -263,5 +271,15 @@ 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 *internalSocket;
+} php_zmq_zyre;
+#endif
 
 #endif /* _PHP_ZMQ_PRIVATE_H_ */

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"

tests/zyre-003.phpt

@@ -0,0 +1,79 @@
+--TEST--
+Test [Zyre] Zyre objects can exchange data in a group of peer
+--SKIPIF--
+<?php require_once(dirname(__FILE__) . '/skipzyre.inc'); ?>
+--FILE--
+<?php
+
+$ctx = new ZMQContext;
+
+$z1 = new ZMQZyre($ctx);
+$z1->start();
+$z1->join('ZMQZyreTestGroup');
+
+
+$z2 = new ZMQZyre($ctx);
+$z2->start();
+$z2->join('ZMQZyreTestGroup');
+
+
+usleep(100000);
+
+// Enter
+$obj = $z1->recv();
+var_dump($obj->command);
+
+// Join
+$obj = $z1->recv();
+var_dump($obj->command);
+var_dump($obj->group);
+
+// Enter
+$obj = $z2->recv();
+var_dump($obj->command);
+
+// Join
+$obj = $z2->recv();
+var_dump($obj->command);
+var_dump($obj->group);
+
+$z2->sendGroup('ZMQZyreTestGroup', 'Some usefull data');
+
+usleep(100000);
+
+// SHOUT
+$obj = $z1->recv();
+var_dump($obj->group);
+var_dump($obj->data);
+
+$z1->leave('ZMQZyreTestGroup');
+
+usleep(100000);
+
+// Leave
+$obj = $z2->recv();
+var_dump($obj->command);
+var_dump($obj->group);
+
+$z1->stop();
+
+usleep(100000);
+
+// Exit
+$obj = $z2->recv();
+var_dump($obj->command);
+
+$z2->stop();
+
+--EXPECTF--
+string(5) "ENTER"
+string(4) "JOIN"
+string(16) "ZMQZyreTestGroup"
+string(5) "ENTER"
+string(4) "JOIN"
+string(16) "ZMQZyreTestGroup"
+string(16) "ZMQZyreTestGroup"
+string(17) "Some usefull data"
+string(5) "LEAVE"
+string(16) "ZMQZyreTestGroup"
+string(4) "EXIT"

tests/zyre-004.phpt

@@ -0,0 +1,49 @@
+--TEST--
+Test [Zyre] Zyre objects can exchange data with a peer
+--SKIPIF--
+<?php require_once(dirname(__FILE__) . '/skipzyre.inc'); ?>
+--FILE--
+<?php
+
+$ctx = new ZMQContext;
+
+$z1 = new ZMQZyre($ctx);
+$z1->start();
+
+$z2 = new ZMQZyre($ctx);
+$z2->start();
+
+usleep(100000);
+
+// Enter
+$obj = $z1->recv();
+var_dump($obj->command);
+
+// Enter
+$obj = $z2->recv();
+var_dump($obj->command);
+$peer = $obj->peer;
+
+$z2->sendPeer($peer, 'Some very usefull data');
+
+usleep(100000);
+
+// SHOUT
+$obj = $z1->recv();
+var_dump($obj->data);
+
+$z1->stop();
+
+usleep(100000);
+
+// Exit
+$obj = $z2->recv();
+var_dump($obj->command);
+
+$z2->stop();
+
+--EXPECTF--
+string(5) "ENTER"
+string(5) "ENTER"
+string(22) "Some very usefull data"
+string(4) "EXIT"