类 CBackendFileTransfer 继承关系图:

[图例]

CBackendFileTransfer 的协作图:

[图例]

信号
void	sigGetDir (CRemoteFileSystem *pRemoteFileSystem, QVector< QSharedPointer< CRemoteFileSystem > > contents, bool bEnd)
void	sigFileTransferUpdate (QSharedPointer< CFileTransfer > f)
信号继承自 CBackend
void	sigRunning ()
	当插件开始成功后触发。仅由插件触发
void	sigStop ()
	需要通知用户停止时触发。仅由插件触发。当从插件中需要停止时触发。例如：对端断开连接、重置连接或者连接出错。
void	sigFinished ()
	停止成功信号。仅由插件触发
void	sigError (const int nError, const QString &szError=QString())
	当有错误产生时触发
void	sigInformation (const QString &szInfo)
	从后台线程中触发在主线程中显示信息，不阻塞后台线程
void	sigShowMessageBox (const QString &szTitle, const QString &szMessage, const QMessageBox::Icon &icon=QMessageBox::Information)
	从后台线程中触发在主线程中显示消息对话框(QMessageBox)，不阻塞后台线程
void	sigBlockShowMessageBox (const QString &szTitle, const QString &szMessage, QMessageBox::StandardButtons buttons, QMessageBox::StandardButton &nRet, bool &checkBox, QString checkBoxContext=QString())
	阻塞后台线程，并在前台线程中显示消息对话框(QMessageBox)
void	sigBlockInputDialog (const QString &szTitle, const QString &szLable, const QString &szMessage, QString &szText)
	阻塞后台线程，并在前台线程中显示输入对话框 (QInputDialog)
void	sigBlockShowWidget (const QString &className, int &nRet, void *pContext)
	阻塞后台线程，并在前台线程中显示窗口。
void	sigSecurityLevel (CSecurityLevel::Levels level)
	当安全级别改变时触发

Public 成员函数
	CBackendFileTransfer (COperateFileTransfer *pOperate)
virtual int	WakeUp () override
	唤醒后台线程。
virtual bool	event (QEvent *event) override
Public 成员函数继承自 CBackend
	CBackend (COperate *pOperate=nullptr, bool bStopSignal=true)
	CBackend
virtual int	Start ()
	开始。根据　OnInit()　返回值来决定是否开始定时器来支持非 qt 事件
virtual int	Stop ()
	停止

Protected 成员函数
virtual OnInitReturnValue	OnInit () override
	初始化
virtual int	OnClean () override
	清理
virtual int	OnProcess () override
	具体操作处理

Private 槽
void	slotMakeDir (const QString &szDir)
void	slotRemoveDir (const QString &szDir)
void	slotGetDir (CRemoteFileSystem *pRemoteFileSystem)
void	slotRemoveFile (const QString &szFile)
void	slotRename (const QString &oldName, const QString &newName)
void	slotStartFileTransfer (QSharedPointer< CFileTransfer > f)
void	slotStopFileTransfer (QSharedPointer< CFileTransfer > f)

Private 成员函数
int	SetConnect (COperateFileTransfer *pOperate)
OnInitReturnValue	InitSFTP ()

Private 属性
COperateFileTransfer *	m_pOperate
CParameterFileTransfer *	m_pPara

额外继承的成员函数
Protected 类型继承自 CBackend
enum class	OnInitReturnValue { Fail = -1 , Success = 0 , UseOnProcess = Success , NotUseOnProcess = 1 }
Protected 槽继承自 CBackend
virtual void	slotTimeOut ()
	一个非 Qt 事件处理，它调用 OnProcess()，并根据其返回值开始新的定时器。如果是不是一个非 Qt 事件循环（就是普通的循环处理），可以重载它，或者 OnInit() 返回值 OnInitReturnValue::NotUseOnProcess

详细描述

在文件 BackendFileTransfer.h 第 14 行定义.

构造及析构函数说明

◆ CBackendFileTransfer()

CBackendFileTransfer::CBackendFileTransfer ( COperateFileTransfer * pOperate )

在文件 BackendFileTransfer.cpp 第 44 行定义.

◆ ~CBackendFileTransfer()

CBackendFileTransfer::~CBackendFileTransfer ( )

virtual

在文件 BackendFileTransfer.cpp 第 58 行定义.

成员函数说明

◆ event()

bool CBackendFileTransfer::event ( QEvent * event )

overridevirtual

在文件 BackendFileTransfer.cpp 第 68 行定义.

◆ InitSFTP()

CBackendFileTransfer::OnInitReturnValue CBackendFileTransfer::InitSFTP ( )

private

在文件 BackendFileTransfer.cpp 第 196 行定义.

◆ OnClean()

int CBackendFileTransfer::OnClean ( )

overrideprotectedvirtual

清理

参见: Stop()

实现了 CBackend.

在文件 BackendFileTransfer.cpp 第 136 行定义.

◆ OnInit()

CBackend::OnInitReturnValue CBackendFileTransfer::OnInit ( )

overrideprotectedvirtual

初始化

返回

OnInitReturnValue::Fail: 错误
OnInitReturnValue::Success/OnInitReturnValue::UseOnProcess: 使用 OnProcess() (非 Qt 事件循环)
OnInitReturnValue::NotUseOnProcess: 不使用 OnProcess() (qt 事件循环)

参见: Start()

实现了 CBackend.

在文件 BackendFileTransfer.cpp 第 128 行定义.

◆ OnProcess()

int CBackendFileTransfer::OnProcess ( )

overrideprotectedvirtual

具体操作处理

返回

>= 0: 继续。再次调用间隔时间，单位毫秒
= -1: 停止
< -1: 错误代码

参见: Start() slotTimeOut()

重载 CBackend .

在文件 BackendFileTransfer.cpp 第 149 行定义.

◆ SetConnect()

int CBackendFileTransfer::SetConnect ( COperateFileTransfer * pOperate )

private

在文件 BackendFileTransfer.cpp 第 159 行定义.

◆ slotGetDir

void CBackendFileTransfer::slotGetDir ( CRemoteFileSystem * pRemoteFileSystem )

privateslot

在文件 BackendFileTransfer.cpp 第 253 行定义.

◆ slotMakeDir

void CBackendFileTransfer::slotMakeDir ( const QString & szDir )

privateslot

在文件 BackendFileTransfer.cpp 第 217 行定义.

◆ slotRemoveDir

void CBackendFileTransfer::slotRemoveDir ( const QString & szDir )

privateslot

在文件 BackendFileTransfer.cpp 第 226 行定义.

◆ slotRemoveFile

void CBackendFileTransfer::slotRemoveFile ( const QString & szFile )

privateslot

在文件 BackendFileTransfer.cpp 第 235 行定义.

◆ slotRename

void CBackendFileTransfer::slotRename	(	const QString &	oldName,
		const QString &	newName )

privateslot

在文件 BackendFileTransfer.cpp 第 244 行定义.

◆ slotStartFileTransfer

void CBackendFileTransfer::slotStartFileTransfer ( QSharedPointer< CFileTransfer > f )

privateslot

在文件 BackendFileTransfer.cpp 第 265 行定义.

◆ slotStopFileTransfer

void CBackendFileTransfer::slotStopFileTransfer ( QSharedPointer< CFileTransfer > f )

privateslot

在文件 BackendFileTransfer.cpp 第 275 行定义.

◆ WakeUp()

int CBackendFileTransfer::WakeUp ( )

overridevirtual

唤醒后台线程。

注解: 调用者是主线程（UI线程）。

实现了 CBackend.

在文件 BackendFileTransfer.cpp 第 63 行定义.

类成员变量说明

◆ m_pOperate

COperateFileTransfer* CBackendFileTransfer::m_pOperate

private

在文件 BackendFileTransfer.h 第 51 行定义.

◆ m_pPara

CParameterFileTransfer* CBackendFileTransfer::m_pPara

private

在文件 BackendFileTransfer.h 第 55 行定义.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FileTransfer/BackendFileTransfer.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/FileTransfer/BackendFileTransfer.cpp

信号

Public 成员函数

Protected 成员函数

Private 槽

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ CBackendFileTransfer()

◆ ~CBackendFileTransfer()

成员函数说明

◆ event()

◆ InitSFTP()

◆ OnClean()

◆ OnInit()

◆ OnProcess()

◆ SetConnect()

◆ slotGetDir

◆ slotMakeDir

◆ slotRemoveDir

◆ slotRemoveFile

◆ slotRename

◆ slotStartFileTransfer

◆ slotStopFileTransfer

◆ WakeUp()

类成员变量说明

◆ m_pOperate

◆ m_pPara