X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink.h;h=2763ad8d214ff2d52d2ec3b0ec373c8a0cb12a07;hb=5f2e8877486869471041b0eca1aaed841c41a1a9;hp=6a50eb66f1b3a54776e6c5c5ce191570631a6aee;hpb=e216dc2392283cb702c2ef95a79086679c063e4d;p=meshlink diff --git a/src/meshlink.h b/src/meshlink.h index 6a50eb66..2763ad8d 100644 --- a/src/meshlink.h +++ b/src/meshlink.h @@ -151,6 +151,7 @@ extern const char *meshlink_strerror(meshlink_errno_t err) __attribute__((__warn * After the function returns, the application is free to overwrite or free @a confbase. * @param name The name which this instance of the application will use in the mesh. * After the function returns, the application is free to overwrite or free @a name. + * If NULL is passed as the name, the name used last time the MeshLink instance was initialized is used. * @param appname The application name which will be used in the mesh. * After the function returns, the application is free to overwrite or free @a name. * @param devclass The device class which will be used in the mesh. @@ -228,6 +229,7 @@ extern struct meshlink_handle *meshlink_open_ex(const meshlink_open_params_t *pa * After the function returns, the application is free to overwrite or free @a confbase. * @param name The name which this instance of the application will use in the mesh. * After the function returns, the application is free to overwrite or free @a name. + * If NULL is passed as the name, the name used last time the MeshLink instance was initialized is used. * @param appname The application name which will be used in the mesh. * After the function returns, the application is free to overwrite or free @a name. * @param devclass The device class which will be used in the mesh. @@ -257,6 +259,7 @@ extern struct meshlink_handle *meshlink_open(const char *confbase, const char *n * After the function returns, the application is free to overwrite or free @a confbase. * @param name The name which this instance of the application will use in the mesh. * After the function returns, the application is free to overwrite or free @a name. + * If NULL is passed as the name, the name used last time the MeshLink instance was initialized is used. * @param appname The application name which will be used in the mesh. * After the function returns, the application is free to overwrite or free @a name. * @param devclass The device class which will be used in the mesh. @@ -1136,7 +1139,7 @@ extern bool meshlink_whitelist(struct meshlink_handle *mesh, struct meshlink_nod * * \memberof meshlink_node * @param mesh A handle which represents an instance of MeshLink. - * @param node A pointer to a struct meshlink_node describing the node to be whitelisted. + * @param name The name of the node to whitelist. * * @return This function returns true if the node has been whitelisted, false otherwise. */ @@ -1521,7 +1524,7 @@ extern size_t meshlink_channel_get_mss(struct meshlink_handle *mesh, struct mesh * * \memberof meshlink_node * @param mesh A handle which represents an instance of MeshLink. - * @param channel A handle for the channel. + * @param node A pointer to a struct meshlink_node describing the node to set the channel connection timeout for. * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed. * The default is 60 seconds. */