X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink.h;h=5777301aebdf58fe9bb599f43a26727d3fa2dff3;hb=0d237f8c1b3a1ddf57c81a1fda2e66892915aee7;hp=6a83f6c60b41772c8ea529675ed737e9f45fa6a9;hpb=529b4d002a9b8cfb9be829b1d1422b4a2e1205d2;p=meshlink diff --git a/src/meshlink.h b/src/meshlink.h index 6a83f6c6..5777301a 100644 --- a/src/meshlink.h +++ b/src/meshlink.h @@ -180,6 +180,7 @@ extern bool meshlink_start(meshlink_handle_t *mesh); * close all sockets, and shut down its own thread. * * This function always succeeds. It is allowed to call meshlink_stop() even if MeshLink is already stopped or has never been started. + * Channels that are still open will remain valid, but any communication via channels will stop as well. * * @param mesh A handle which represents an instance of MeshLink. */ @@ -187,7 +188,7 @@ extern void meshlink_stop(meshlink_handle_t *mesh); /// Close the MeshLink handle. /** This function calls meshlink_stop() if necessary, - * and frees the struct meshlink_handle and all associacted memory allocated by MeshLink. + * and frees the struct meshlink_handle and all associacted memory allocated by MeshLink, including all channels. * Afterwards, the handle and any pointers to a struct meshlink_node or struct meshlink_channel are invalid. * * It is allowed to call this function at any time on a valid handle, except inside callback functions.