后端接口。它由协议插件实现。它默认启动一个定时器来开启一个非 Qt 事件循环（就是普通的循环处理）。详见： Start()、 slotTimeOut()、 OnProcess() 。当然，它仍然支持 Qt 事件（QObject 的信号－槽机制）。更多...

#include <Backend.h>

类 CBackend 继承关系图:

[图例]

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 成员函数
	CBackend (COperate *pOperate=nullptr, bool bStopSignal=true)
	CBackend
virtual int	Start ()
	开始。根据　OnInit()　返回值来决定是否开始定时器来支持非 qt 事件
virtual int	Stop ()
	停止
virtual int	WakeUp ()=0
	唤醒后台线程。

Protected 类型
enum class	OnInitReturnValue { Fail = -1 , Success = 0 , UseOnProcess = Success , NotUseOnProcess = 1 }

Protected 槽
virtual void	slotTimeOut ()
	一个非 Qt 事件处理，它调用 OnProcess()，并根据其返回值开始新的定时器。如果是不是一个非 Qt 事件循环（就是普通的循环处理），可以重载它，或者 OnInit() 返回值 OnInitReturnValue::NotUseOnProcess

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

Private 成员函数
int	SetConnect (COperate *pOperate)

Private 属性
bool	m_bStopSignal
	When an error occurs, emit a COperate::sigStop() signal

详细描述

后端接口。它由协议插件实现。它默认启动一个定时器来开启一个非 Qt 事件循环（就是普通的循环处理）。详见： Start()、 slotTimeOut()、 OnProcess() 。当然，它仍然支持 Qt 事件（QObject 的信号－槽机制）。

注解

这个接口仅由插件实现。
如果是异步的（有后台线程），它的实例在后台线程中。
具体的插件需要实现下面接口：
信号：
- 当开始/初始化完成后，必须触发 sigRunning() 信号
- 当停止/清理完成后，必须触发 sigFinished() 信号
- 如果内部需要停止，则触发 sigStop() 信号
- 如果内部出错，则触发 sigError() 信号和 sigStop() 信号

参见: CBackendThread::run() CFrmViewer

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

成员枚举类型说明

◆ OnInitReturnValue

enum class CBackend::OnInitReturnValue

strongprotected

在文件 Backend.h 第 107 行定义.

构造及析构函数说明

◆ CBackend()

CBackend::CBackend	(	COperate *	pOperate = nullptr,
		bool	bStopSignal = true )

explicit

CBackend

参数

pOperate
bStopSignal	true: When an error occurs, emit a COperate::sigStop() signal false: not emit signal

◆ ~CBackend()

CBackend::~CBackend ( )

virtual

在文件 Backend.cpp 第 18 行定义.

成员函数说明

◆ OnClean()

virtual int CBackend::OnClean ( )

protectedpure virtual

清理

参见: Stop()

在 CBackendFileTransfer, CBackendFreeRDP, CBackendFreeRDPServer, CBackendFtpServer, CBackendLibVNCServer, CBackendPlayer, CBackendSftpServer, CBackendSSH, CBackendTemplateBase, CBackendTemplateDesktop, CBackendTemplateQtEvent, CBackendTemplateServer , 以及 CBackendVnc 内被实现.

◆ OnInit()

virtual OnInitReturnValue CBackend::OnInit ( )

nodiscardprotectedpure virtual

初始化

返回

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

参见: Start()

在 CBackendFileTransfer, CBackendFreeRDP, CBackendFreeRDPServer, CBackendFtpServer, CBackendLibVNCServer, CBackendPlayer, CBackendSftpServer, CBackendSSH, CBackendTemplateBase, CBackendTemplateDesktop, CBackendTemplateQtEvent, CBackendTemplateServer , 以及 CBackendVnc 内被实现.

◆ OnProcess()

int CBackend::OnProcess ( )

nodiscardprotectedvirtual

具体操作处理

返回

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

参见: Start() slotTimeOut()

被 CBackendFileTransfer, CBackendFreeRDP, CBackendFreeRDPServer, CBackendLibVNCServer, CBackendSftpServer, CBackendSSH, CBackendTemplateBase, CBackendTemplateDesktop, CBackendTemplateServer , 以及 CBackendVnc 重载.

在文件 Backend.cpp 第 143 行定义.

◆ SetConnect()

int CBackend::SetConnect ( COperate * pOperate )

private

在文件 Backend.cpp 第 23 行定义.

◆ sigBlockInputDialog

void CBackend::sigBlockInputDialog	(	const QString &	szTitle,
		const QString &	szLable,
		const QString &	szMessage,
		QString &	szText )

signal

阻塞后台线程，并在前台线程中显示输入对话框 (QInputDialog)

参见: COperate::slotBlockInputDialog() SetConnect

◆ sigBlockShowMessageBox

void CBackend::sigBlockShowMessageBox	(	const QString &	szTitle,
		const QString &	szMessage,
		QMessageBox::StandardButtons	buttons,
		QMessageBox::StandardButton &	nRet,
		bool &	checkBox,
		QString	checkBoxContext = QString() )

signal

阻塞后台线程，并在前台线程中显示消息对话框(QMessageBox)

参见: COperate::slotBlockShowMessageBox() SetConnect

◆ sigBlockShowWidget

void CBackend::sigBlockShowWidget	(	const QString &	className,
		int &	nRet,
		void *	pContext )

signal

阻塞后台线程，并在前台线程中显示窗口。

参见: COperate::slotBlockShowWidget() SetConnect

◆ sigFinished

void CBackend::sigFinished ( )

signal

停止成功信号。仅由插件触发

参见: Stop

◆ sigInformation

void CBackend::sigInformation ( const QString & szInfo )

signal

从后台线程中触发在主线程中显示信息，不阻塞后台线程

注解: 它与 sigShowMessageBox 的区别是 sigShowMessageBox 用对话框显示

参见: sigShowMessageBox SetConnect COperate::sigInformation()

◆ sigShowMessageBox

void CBackend::sigShowMessageBox	(	const QString &	szTitle,
		const QString &	szMessage,
		const QMessageBox::Icon &	icon = QMessageBox::Information )

signal

从后台线程中触发在主线程中显示消息对话框(QMessageBox)，不阻塞后台线程

注解: 它与 sigInformation 区别是，sigInformation 不用对话框显示

参见: sigInformation SetConnect COperate::sigShowMessageBox()

◆ slotTimeOut

void CBackend::slotTimeOut ( )

protectedvirtualslot

一个非 Qt 事件处理，它调用 OnProcess()，并根据其返回值开始新的定时器。如果是不是一个非 Qt 事件循环（就是普通的循环处理），可以重载它，或者 OnInit() 返回值 OnInitReturnValue::NotUseOnProcess

参见: Start() OnProcess()

在文件 Backend.cpp 第 111 行定义.

◆ Start()

int CBackend::Start ( )

virtual

开始。根据　OnInit()　返回值来决定是否开始定时器来支持非 qt 事件

注解

如果是异步的，开始成功后触发 sigRunning() 。
如果是同步的，则在此函数成功调用后，触发 sigRunning() 。

返回

= 0: success
< 0: error

参见: sigRunning(); OnInit() OnProcess() slotTimeOut()

在文件 Backend.cpp 第 84 行定义.

◆ Stop()

int CBackend::Stop ( )

virtual

停止

返回: 0: success; other error

参见: sigFinished()

在文件 Backend.cpp 第 103 行定义.

◆ WakeUp()

virtual int CBackend::WakeUp ( )

pure virtual

唤醒后台线程。

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

在 CBackendFileTransfer, CBackendFreeRDP, CBackendFreeRDPServer, CBackendFtpServer, CBackendLibVNCServer, CBackendPlayer, CBackendSftpServer, CBackendSSH, CBackendTemplateBase, CBackendTemplateDesktop, CBackendTemplateQtEvent , 以及 CBackendVnc 内被实现.

类成员变量说明

◆ m_bStopSignal

bool CBackend::m_bStopSignal

private

When an error occurs, emit a COperate::sigStop() signal

在文件 Backend.h 第 298 行定义.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Backend.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Backend.cpp

信号

Public 成员函数

Protected 类型

Protected 槽

Protected 成员函数

Private 成员函数

Private 属性

详细描述

成员枚举类型说明

◆ OnInitReturnValue

构造及析构函数说明

◆ CBackend()

◆ ~CBackend()

成员函数说明

◆ OnClean()

◆ OnInit()

◆ OnProcess()

◆ SetConnect()

◆ sigBlockInputDialog

◆ sigBlockShowMessageBox

◆ sigBlockShowWidget

◆ sigFinished

◆ sigInformation

◆ sigShowMessageBox

◆ slotTimeOut

◆ Start()

◆ Stop()

◆ WakeUp()

类成员变量说明

◆ m_bStopSignal