Ma/mscp
1
0
Fork 0
mirror of https://github.com/upa/mscp.git synced 2026-03-06 23:57:33 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

add note to mscp_cleanup() and mscp_free()

Browse Source 
mscp_join() must be called before mscp_cleanup() and mscp_free()
are called. Need fix.
This commit is contained in:
Ryo Nakamura
2023-03-11 22:11:44 +09:00
parent 74d58e986a
commit 855ee618a6
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/mscp.h
View File

@@ -208,16 +208,21 @@ int mscp_join(struct mscp *m);
void mscp_get_stats(struct mscp *m, struct mscp_stats *s); void mscp_get_stats(struct mscp *m, struct mscp_stats *s);
/** /**
* @brief Cleanup the mscp instance. Before calling mscp_cleanup(), must * @brief Cleanup the mscp instance. Before calling mscp_cleanup(),
* call mscp_join(). After mscp_cleanup() called, the mscp instance * must call mscp_join(). After mscp_cleanup() called, the mscp
* can restart from mscp_connect(). * instance can restart from mscp_connect(). Note that do not call
* mscp_cleanup() before callign mscp_join(). It causes crash (ToDo:
* check status of copy threads and return error when they are
* running).
* *
* @param m mscp instance. * @param m mscp instance.
*/ */
void mscp_cleanup(struct mscp *m); void mscp_cleanup(struct mscp *m);
/** /**
* @brief Release the mscp instance. * @brief Release the mscp instance. Note that do not call *
mscp_free() before calling mscp_join(). It causes crash (ToDo: check
* status of copy threads and return error when they are running).
* *
* @param m mscp instance. * @param m mscp instance.
*/ */