Permalink
Browse files

Clarified API

  • Loading branch information...
1 parent e3377bc commit 702b35299bb197f39476695ce88bb7f59f7c1b06 @hintjens hintjens committed Mar 18, 2013
Showing with 7 additions and 7 deletions.
  1. +7 −7 include/zbeacon.h
View
@@ -35,14 +35,18 @@ extern "C" {
typedef struct _zbeacon_t zbeacon_t;
// @interface
-// Create a new beacon
+// Create a new beacon on a certain UDP port
CZMQ_EXPORT zbeacon_t *
zbeacon_new (int port_nbr);
// Destroy a beacon
CZMQ_EXPORT void
zbeacon_destroy (zbeacon_t **self_p);
+// Return our own IP address as printable string
+CZMQ_EXPORT char *
+ zbeacon_hostname (zbeacon_t *self);
+
// Set broadcast interval in milliseconds (default is 1000 msec)
CZMQ_EXPORT void
zbeacon_set_interval (zbeacon_t *self, int interval);
@@ -67,14 +71,10 @@ CZMQ_EXPORT void
CZMQ_EXPORT void
zbeacon_unsubscribe (zbeacon_t *self);
-// Get beacon pipe, for polling or receiving messages off
+// Get beacon pipe, for polling or receiving messages
CZMQ_EXPORT void *
zbeacon_pipe (zbeacon_t *self);
-
-// Return our own IP address as printable string
-CZMQ_EXPORT char *
- zbeacon_hostname (zbeacon_t *self);
-
+
// Self test of this class
void
zbeacon_test (bool verbose);

0 comments on commit 702b352

Please sign in to comment.