Permalink
Browse files

Problem: Docs are not up to date

Solution: re-generate them
  • Loading branch information...
sappo committed May 20, 2018
1 parent 3d84c79 commit 36f8ef9f6591135873e5dccebd56ddd7c9de07c2
Showing with 38 additions and 0 deletions.
  1. +19 −0 doc/zyre.doc
  2. +19 −0 doc/zyre.txt
View
@@ -228,6 +228,21 @@ This is the class interface:
zyre_test (bool verbose);
#ifdef ZYRE_BUILD_DRAFT_API
// *** Draft method, for development use, may change without warning ***
// This options enables a peer to actively contest for leadership in the
// given group. If this option is not set the peer will still participate in
// elections but never gets elected. This ensures that a consent for a leader
// is reached within a group even though not every peer is contesting for
// leadership.
ZYRE_EXPORT void
zyre_set_contest_in_group (zyre_t *self, const char *group);
// *** Draft method, for development use, may change without warning ***
// Set an alternative endpoint value when using GOSSIP ONLY. This is useful
// if you're advertising an endpoint behind a NAT.
ZYRE_EXPORT void
zyre_set_advertised_endpoint (zyre_t *self, const char *value);
// *** Draft method, for development use, may change without warning ***
// Apply a azcert to a Zyre node.
ZYRE_EXPORT void
@@ -569,6 +584,10 @@ This is the class self test code:
zyre_set_header(node5, "X-PUBLICKEY", "%s", zcert_public_txt(node5_cert));
zyre_set_header(node6, "X-PUBLICKEY", "%s", zcert_public_txt(node6_cert));
// TODO- set_advertised_endpoint tests
// zyre_set_endpoint(node5, "tcp://127.0.0.1:9001");
// zyre_set_advertised_endpoint(node5, "tcp://localhost:9001");
const char *gossip_cert = zcert_public_txt (node5_cert);
// TODO- need to add zyre_gossip_port functions to get port from gossip bind(?)
View
@@ -199,6 +199,21 @@ ZYRE_EXPORT void
zyre_test (bool verbose);
#ifdef ZYRE_BUILD_DRAFT_API
// *** Draft method, for development use, may change without warning ***
// This options enables a peer to actively contest for leadership in the
// given group. If this option is not set the peer will still participate in
// elections but never gets elected. This ensures that a consent for a leader
// is reached within a group even though not every peer is contesting for
// leadership.
ZYRE_EXPORT void
zyre_set_contest_in_group (zyre_t *self, const char *group);
// *** Draft method, for development use, may change without warning ***
// Set an alternative endpoint value when using GOSSIP ONLY. This is useful
// if you're advertising an endpoint behind a NAT.
ZYRE_EXPORT void
zyre_set_advertised_endpoint (zyre_t *self, const char *value);
// *** Draft method, for development use, may change without warning ***
// Apply a azcert to a Zyre node.
ZYRE_EXPORT void
@@ -578,6 +593,10 @@ if (zsys_has_curve()){
zyre_set_header(node5, "X-PUBLICKEY", "%s", zcert_public_txt(node5_cert));
zyre_set_header(node6, "X-PUBLICKEY", "%s", zcert_public_txt(node6_cert));
// TODO- set_advertised_endpoint tests
// zyre_set_endpoint(node5, "tcp://127.0.0.1:9001");
// zyre_set_advertised_endpoint(node5, "tcp://localhost:9001");
const char *gossip_cert = zcert_public_txt (node5_cert);
// TODO- need to add zyre_gossip_port functions to get port from gossip bind(?)

0 comments on commit 36f8ef9

Please sign in to comment.