查看源代码 ct_ftp (common_test v1.27.5)

FTP 客户端模块 (基于 ftp 应用)。

概要

类型

指向已打开的 FTP 连接的引用,该连接与 handletarget_name 相关联。

特定 FTP 连接的句柄,请参阅模块 ct

函数

更改远程主机上的目录。

关闭 FTP 连接。

删除远程主机上的文件。

打开 FTP 连接并从远程主机获取文件。

列出目录 Dir

打开到指定节点的 FTP 连接。

打开 FTP 连接并将文件发送到远程主机。

通过 FTP 获取文件。

通过 FTP 获取文件。

通过 FTP 发送文件。

通过 FTP 发送文件。

更改文件传输类型。

类型

-type connection() :: handle() | ct:target_name().

指向已打开的 FTP 连接的引用,该连接与 handletarget_name 相关联。

-type handle() :: ct:handle().

特定 FTP 连接的句柄,请参阅模块 ct

函数

-spec cd(Connection, Dir) -> ok | {error, Reason}
            when Connection :: connection(), Dir :: file:filename(), Reason :: term().

更改远程主机上的目录。

-spec close(Connection) -> ok | {error, Reason} when Connection :: connection(), Reason :: term().

关闭 FTP 连接。

链接到此函数

delete(Connection, File)

查看源代码
-spec delete(Connection, File) -> ok | {error, Reason}
                when Connection :: connection(), File :: file:filename(), Reason :: term().

删除远程主机上的文件。

链接到此函数

get(KeyOrName, RemoteFile, LocalFile)

查看源代码
-spec get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason}
             when
                 KeyOrName :: ct:key_or_name(),
                 RemoteFile :: file:filename(),
                 LocalFile :: file:filename(),
                 Reason :: term().

打开 FTP 连接并从远程主机获取文件。

RemoteFileLocalFile 必须是绝对路径。

配置文件必须与 ct_ftp:put/3 相同。

另请参阅 ct:require/2

-spec ls(Connection, Dir) -> {ok, Listing} | {error, Reason}
            when
                Connection :: connection(),
                Dir :: file:filename(),
                Listing :: string(),
                Reason :: term().

列出目录 Dir

-spec open(KeyOrName) -> {ok, Handle} | {error, Reason}
              when KeyOrName :: ct:key_or_name(), Handle :: handle(), Reason :: term().

打开到指定节点的 FTP 连接。

您可以为特定的 Name 打开一个连接,并将相同的名称用作所有后续操作的引用。如果您希望将连接与 Handle 相关联(例如,如果您需要打开到主机的多个连接),请使用 Key,即配置变量名称,来指定目标。没有关联目标名称的连接只能使用句柄值关闭。

有关如何创建新的 Name 的信息,请参阅 ct:require/2

链接到此函数

put(KeyOrName, LocalFile, RemoteFile)

查看源代码
-spec put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason}
             when
                 KeyOrName :: ct:key_or_name(),
                 LocalFile :: file:filename(),
                 RemoteFile :: file:filename(),
                 Reason :: term().

打开 FTP 连接并将文件发送到远程主机。

LocalFileRemoteFile 必须是绝对路径。

如果目标主机是“特殊”节点,则必须在配置文件中指定 FTP 地址,如下所示

{node,[{ftp,IpAddr}]}.

如果目标主机是其他东西,例如 UNIX 主机,则配置文件还必须包括用户名和密码(均为字符串)

{unix,[{ftp,IpAddr},
       {username,Username},
       {password,Password}]}.

另请参阅 ct:require/2

链接到此函数

recv(Connection, RemoteFile)

查看源代码
-spec recv(Connection, RemoteFile) -> ok | {error, Reason}
              when Connection :: connection(), RemoteFile :: file:filename(), Reason :: term().

通过 FTP 获取文件。

该文件在本地主机上获得相同的名称。

另请参阅 ct_ftp:recv/3

链接到此函数

recv(Connection, RemoteFile, LocalFile)

查看源代码
-spec recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason}
              when
                  Connection :: connection(),
                  RemoteFile :: file:filename(),
                  LocalFile :: file:filename(),
                  Reason :: term().

通过 FTP 获取文件。

该文件在本地主机上命名为 LocalFile

链接到此函数

send(Connection, LocalFile)

查看源代码
-spec send(Connection, LocalFile) -> ok | {error, Reason}
              when Connection :: connection(), LocalFile :: file:filename(), Reason :: term().

通过 FTP 发送文件。

该文件在远程主机上获得相同的名称。

另请参阅 ct_ftp:send/3

链接到此函数

send(Connection, LocalFile, RemoteFile)

查看源代码
-spec send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason}
              when
                  Connection :: connection(),
                  LocalFile :: file:filename(),
                  RemoteFile :: file:filename(),
                  Reason :: term().

通过 FTP 发送文件。

该文件在远程主机上命名为 RemoteFile

链接到此函数

type(Connection, Type)

查看源代码
-spec type(Connection, Type) -> ok | {error, Reason}
              when Connection :: connection(), Type :: ascii | binary, Reason :: term().

更改文件传输类型。