Dtk::Mount::DProtocolDevice类 参考

用于操作如 smb/ftp/sftp/mpt/gphoto 等协议设备，处理设备的卸载、挂载以及获取设备属性。 更多...

#include <dprotocoldevice.h>

类 Dtk::Mount::DProtocolDevice 继承关系图:

Dtk::Mount::DProtocolDevice 的协作图:

Public 成员函数
	~DProtocolDevice () override
	析构函数
QString	path () const
	获取在构造对象时指定的设备路径。
QString	mountPoint () const
	获取设备挂载点。
QString	displayName () const
	获取设备名称，通常用于帮助用户在界面中识别设备。
QString	fileSystem () const
	获取设备文件系统。
quint64	sizeTotal () const
	获取设备总容量。
quint64	sizeFree () const
	获取设备可用空间。
quint64	sizeUsage () const
	获取设备已使用容量。
QStringList	iconNames () const
	获取设备图标。
QString	mount (const QVariantMap &opts={})
	挂载指定的设备。
void	mountAsync (const QVariantMap &opts={}, OperateCallbackWithInfo callback=nullptr)
bool	unmount (const QVariantMap &opts={})
	卸载设备的同步函数。
void	unmountAsync (const QVariantMap &opts={}, OperateCallback callback=nullptr)
	unmount 的异步版本
void	setOperateTimeout (int secs=3)
	设置操作超时时间。
void	setAskForPasswd (AskForPasswd callback)
	设置询问用户密码的回调函数。该函数通常在一些需要用户鉴权的设备挂载时使用，例如 smb/ftp/sftp 等。如果没有指定回调函数，默认的用户为本机登录用户，默认密码为空，默认域为 WORKGROUP。
void	setAskForChoice (AskForChoice callback)
	设置询问用户选择的回调函数。该函数通常在一些需要用户抉择的设备挂载时使用。如果没有指定，默认的选择为0。

属性
QString	path
QString	mountPoint
QString	displayName
QString	fileSystem
quint64	sizeTotal
quint64	sizeFree
quint64	sizeUsage
QStringList	iconNames

友元
DCORE_NAMESPACE::DExpected< DProtocolDevice * >	DDeviceManager::createProtocolDevice (const QString &, QObject *)

详细描述

用于操作如 smb/ftp/sftp/mpt/gphoto 等协议设备，处理设备的卸载、挂载以及获取设备属性。

成员函数说明

displayName()

QString DProtocolDevice::displayName

(

)

const

获取设备名称，通常用于帮助用户在界面中识别设备。

返回

当前设备的名称，如果是纯协议设备，并且没有挂载，返回空字符串（未挂载的纯协议设备完全未接入系统）；如果不是纯协议设备，则返回当前设备名称。

注解

纯协议设备通常存在于远端机器，并通过网络链接，例如 smb/ftp/webdav 等；而非纯协议设备通常通过线缆链接，例如手机、数码相机等；

fileSystem()

QString DProtocolDevice::fileSystem

(

)

const

获取设备文件系统。

返回

返回设备文件系统，若未挂载，则返回空字符串。

iconNames()

quint64 DProtocolDevice::iconNames

(

)

const

获取设备图标。

返回

返回设备可用的图标，如果设备没挂载，则返回空列表。

mount()

QString DProtocolDevice::mount

(

const QVariantMap &

opts = {}

)

挂载指定的设备。

参数

[in]

opts

暂未使用的参数。

返回

挂载成功则返回挂载点，否则返回空字符串。

mountAsync()

void DProtocolDevice::mountAsync	(	const QVariantMap &	opts = {},
		OperateCallbackWithInfo	callback = nullptr
	)

参见

QString DProtocolDevice::mount(const QVariantMap &opts) 的异步版本。

参数

[in]	opts	暂未使用的参数。
[in]	callback	回调函数会在挂载完成后调用。挂载结果将传递给该函数以指示挂载是否成功。

mountPoint()

QString DProtocolDevice::mountPoint

(

)

const

获取设备挂载点。

返回

如果设备已挂载，则返回设备挂载点，否则返回空字符串。

path()

QString DProtocolDevice::path

(

)

const

获取在构造对象时指定的设备路径。

返回

返回设置的设备路径。

setOperateTimeout()

void DProtocolDevice::setOperateTimeout

(

int

secs = 3

)

设置操作超时时间。

参数

[in]

secs

0 表示所有操作永不超时，默认超时时间为3秒。

sizeFree()

quint64 DProtocolDevice::sizeFree

(

)

const

获取设备可用空间。

返回

若未挂载，返回 0。

sizeTotal()

quint64 DProtocolDevice::sizeTotal

(

)

const

获取设备总容量。

返回

若未挂载，返回 0。

sizeUsage()

quint64 DProtocolDevice::sizeUsage

(

)

const

获取设备已使用容量。

返回

若未挂载，返回 0。

unmount()

bool DProtocolDevice::unmount

(

const QVariantMap &

opts = {}

)

卸载设备的同步函数。

参数

[in]

opts

暂未使用的参数。

返回

若卸载成功，则返回 true，否则返回 false。

unmountAsync()

void DProtocolDevice::unmountAsync	(	const QVariantMap &	opts = {},
		OperateCallback	callback = nullptr
	)

unmount 的异步版本

参数

[in]	opts	暂未使用的参数。
[in]	callback	回调函数会在异步操作结束后调用，卸载结果会被传递到该函数。

参见

bool DProtocolDevice::unmount(const QVariantMap &opts)

---

该类的文档由以下文件生成:

• include/dtkmount/dprotocoldevice.h
• docs/dtkmount/dprotocoldevice.zh_CN.dox