X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink%2B%2B.h;h=312b42c81aa8bbd5a7ee4e2a1353f1e86fc2bfed;hb=1f9c1231139d2a93ef4ace9891013d2c23cdf4ae;hp=f7b0e1ace4919e5b15530085cf96daed79194ade;hpb=ed1f31db1e8840ffd6849b48bcad93e9975a24bb;p=meshlink

diff --git a/src/meshlink++.h b/src/meshlink++.h
index f7b0e1ac..312b42c8 100644
--- a/src/meshlink++.h
+++ b/src/meshlink++.h
@@ -145,7 +145,7 @@ public:
 	 *  @param confbase The directory in which MeshLink will store its configuration files.
 	 *  @param name     The name which this instance of the application will use in the mesh.
 	 *  @param appname  The application name which will be used in the mesh.
-	 *  @param dclass   The device class which will be used in the mesh.
+	 *  @param devclass The device class which will be used in the mesh.
 	 *
 	 *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
 	 */
@@ -488,8 +488,6 @@ public:
 
 	/// Get the network port used by the local node.
 	/** This function returns the network port that the local node is listening on.
-	 *
-	 *  @param mesh          A handle which represents an instance of MeshLink.
 	 *
 	 *  @return              This function returns the port number, or -1 in case of an error.
 	 */
@@ -531,14 +529,15 @@ public:
 	 *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 	 *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 	 *
+	 *  @param submesh      A handle to the submesh to put the invitee in.
 	 *  @param name         The name that the invitee will use in the mesh.
 	 *  @param flags        A bitwise-or'd combination of flags that controls how the URL is generated.
 	 *
 	 *  @return             This function returns a string that contains the invitation URL.
 	 *                      The application should call free() after it has finished using the URL.
 	 */
-	char *invite(const char *name, uint32_t flags = 0) {
-		return meshlink_invite_ex(handle, name, flags);
+	char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
+		return meshlink_invite_ex(handle, submesh, name, flags);
 	}
 
 	/// Use an invitation to join a mesh.
@@ -615,7 +614,7 @@ public:
 	 *  The application then has to decide whether to accept or reject this channel.
 	 *
 	 *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
-	 *  calls channel_poll. To set a differnt, channel-specific poll callback, use set_channel_poll_cb.
+	 *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
 	 *
 	 *  @param node         The node to which this channel is being initiated.
 	 *  @param port         The port number the peer wishes to connect to.
@@ -632,9 +631,23 @@ public:
 		return ch;
 	}
 
-	/**
-	 * @override
-	 * Sets channel_receive_trampoline as cb, which in turn calls this->channel_receive( ... ).
+	/// Open a reliable stream channel to another node.
+	/** This function is called whenever a remote node wants to open a channel to the local node.
+	 *  The application then has to decide whether to accept or reject this channel.
+	 *
+	 *  This function sets the channel receive callback to channel_receive_trampoline,
+	 *  which in turn calls channel_receive.
+	 *
+	 *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
+	 *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
+	 *
+	 *  @param node         The node to which this channel is being initiated.
+	 *  @param port         The port number the peer wishes to connect to.
+	 *  @param data         A pointer to a buffer containing data to already queue for sending.
+	 *  @param len          The length of the data.
+	 *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
+	 *
+	 *  @return             A handle for the channel, or NULL in case of an error.
 	 */
 	channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
 		channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);