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 This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
*/
bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
handle = meshlink_open(confbase, name, appname, devclass);
(void)message;
}
- /// This functions is called whenever another node attemps to open a channel to the local node.
+ /// This functions is called whenever another node attempts to open a channel to the local node.
/**
* If the channel is accepted, the poll_callback will be set to channel_poll and can be
* changed using set_channel_poll_cb(). Likewise, the receive callback is set to
/** This function causes MeshLink to open network sockets, make outgoing connections, and
* create a new thread, which will handle all network I/O.
*
- * @return This function will return true if MeshLink has succesfully started its thread, false otherwise.
+ * @return This function will return true if MeshLink has successfully started its thread, false otherwise.
*/
bool start() {
meshlink_set_receive_cb(handle, &receive_trampoline);
/// 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.
*/
* If the port is set to 0, then MeshLink will listen on a port
* that is randomly assigned by the operating system every time open() is called.
*
- * @return This function returns true if the port was succesfully changed, false otherwise.
+ * @return This function returns true if the port was successfully changed, false otherwise.
*/
bool set_port(int port) {
return meshlink_set_port(handle, port);
* 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.
/** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
* An invitation can only be used if the local node has never connected to other nodes before.
- * After a succesfully accepted invitation, the name of the local node may have changed.
+ * After a successfully accepted invitation, the name of the local node may have changed.
*
* This function may only be called on a mesh that has not been started yet and which is not already part of an existing 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);
* @param confbase The directory in which MeshLink stores its configuration files.
* After the function returns, the application is free to overwrite or free @a confbase @a.
*
- * @return This function will return true if the MeshLink instance was succesfully destroyed, false otherwise.
+ * @return This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
*/
static inline bool destroy(const char *confbase) {
return meshlink_destroy(confbase);