Merge pull request #661 from Dysl3xik/master

Documentation Update
zeromq · Mar 4, 2020 · e4245e6 · e4245e6
2 parents 6b189b9 + 11fdb26
commit e4245e6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/api/zyre.api b/api/zyre.api
@@ -106,6 +106,8 @@
         Set network interface for UDP beacons. If you do not set this, CZMQ will
         choose an interface for you. On boxes with several interfaces you should
         specify which one you want to use, or strange things can happen.
+        The interface may by specified by either the interface name e.g. "eth0" or
+        an IP address associalted with the interface e.g. "192.168.0.1"
         <argument name = "value" type = "string" />
     </method>
 

diff --git a/include/zyre.h b/include/zyre.h
@@ -104,6 +104,8 @@ ZYRE_EXPORT void
 //  Set network interface for UDP beacons. If you do not set this, CZMQ will
 //  choose an interface for you. On boxes with several interfaces you should
 //  specify which one you want to use, or strange things can happen.
+//  The interface may by specified by either the interface name e.g. "eth0" or
+//  an IP address associalted with the interface e.g. "192.168.0.1"
 ZYRE_EXPORT void
     zyre_set_interface (zyre_t *self, const char *value);