class mesh;
class node;
class channel;
+class submesh;
/// Severity of log messages generated by MeshLink.
typedef meshlink_log_level_t log_level_t;
class node: public meshlink_node_t {
};
+/// A class describing a MeshLink Sub-Mesh.
+class submesh: public meshlink_submesh_t {
+};
+
/// A class describing a MeshLink channel.
class channel: public meshlink_channel_t {
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.
*/
return meshlink_get_external_address_for_family(handle, family);
}
+ /** This function performs tries to discover the address of the local interface used for outgoing connection.
+ *
+ * Please note that this is function only returns a single address,
+ * even if the local node might have more than one external address.
+ * In that case, there is no control over which address will be selected.
+ * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
+ * there is no guarantee that the external address will be valid for an extended period of time.
+ *
+ * This function will fail if it couldn't find a local address for the given address family.
+ * If hostname resolving is requested, this function may block for a few seconds.
+ *
+ * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
+ * this might return the external address for any working address family.
+ *
+ * @return This function returns a pointer to a C string containing the discovered external address,
+ * or NULL if there was an error looking up the address.
+ * After get_external_address() returns, the application is free to overwrite or free this string.
+ */
+ bool get_local_address(int family = AF_UNSPEC) {
+ return meshlink_get_local_address_for_family(handle, family);
+ }
+
/// Try to discover the external address for the local node, and add it to its list of addresses.
/** This function is equivalent to:
*
/// 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.
*/
* 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) {
- return meshlink_invite(handle, name);
+ 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.
* 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.
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);
projects / meshlink / blobdiff