From fc45fa2532b37e4c36b2a78b882dbbba85336ff2 Mon Sep 17 00:00:00 2001 From: Ryo Nakamura Date: Sun, 26 Feb 2023 23:56:57 +0900 Subject: add comments to mscp.h --- src/mscp.c | 6 +++++- src/mscp.h | 19 +++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/mscp.c b/src/mscp.c index 2fe9703..df7459a 100644 --- a/src/mscp.c +++ b/src/mscp.c @@ -16,7 +16,7 @@ #include struct mscp { - const char *remote; /* remote host (and uername) */ + char *remote; /* remote host (and uername) */ struct mscp_opts *opts; struct ssh_opts ssh_opts; @@ -597,6 +597,10 @@ void mscp_cleanup(struct mscp *m) void mscp_free(struct mscp *m) { mscp_cleanup(m); + if (m->remote) + free(m->remote); + if (m->cores) + free(m->cores); free(m); } diff --git a/src/mscp.h b/src/mscp.h index ccb57ca..4bed14d 100644 --- a/src/mscp.h +++ b/src/mscp.h @@ -2,6 +2,7 @@ #define _MSCP_H_ #include +#include #define MSCP_DIRECTION_L2R 1 #define MSCP_DIRECTION_R2L 2 @@ -42,13 +43,31 @@ struct mscp_opts { struct mscp; +/* initialize and return a mscp instance with option validation */ struct mscp *mscp_init(const char *remote_host, struct mscp_opts *opts); + +/* establish the first SFTP session. mscp_prepare() and mscp_start() + * requires mscp_connect() beforehand */ int mscp_connect(struct mscp *m); + +/* add a source file path to be copied */ int mscp_add_src_path(struct mscp *m, const char *src_path); + +/* set the destination file path */ int mscp_set_dst_path(struct mscp *m, const char *dst_path); + +/* check source files, resolve destination file paths for all source + * files, and prepare chunks for all files. */ int mscp_prepare(struct mscp *m); + +/* start to copy files */ int mscp_start(struct mscp *m); + +/* cleanup mscp instance. after mscp_cleanup(), process can restart + * from mscp_connect() with the same setting. */ void mscp_cleanup(struct mscp *m); + +/* free mscp instance */ void mscp_free(struct mscp *m); #endif /* _MSCP_H_ */ -- cgit v1.2.3