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

#include <Connect.h>

类 CConnect 继承关系图:

Public 槽
virtual int	Connect ()
	开始连接。根据　OnInit()　返回值来决定是否开始定时器来支持非 qt 事件

virtual int	Disconnect ()
	断开

信号
void	sigConnected ()
	当插件连接成功后触发。仅由插件触发

void	sigDisconnect ()
	通知用户断开连接。仅由插件触发。当从插件中需要要断开连接时触发。例如：对端断开连接、重置连接或者连接出错。

void	sigDisconnected ()
	断开连接成功信号。仅由插件触发

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)
	阻塞后台线程，并在前台线程中显示窗口。

Public 成员函数
	CConnect (CConnecter *pConnecter)

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

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

Protected 成员函数
virtual OnInitReturnValue	OnInit ()=0
	具体的插件实现连接初始化

virtual int	OnClean ()=0
	清理

virtual int	OnProcess ()
	插件连接的具体操作处理

Private 成员函数
int	SetConnecter (CConnecter *pConnecter)

详细描述

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

注解

这个接口仅由插件实现。
如果是异步的（有后台线程），它的实例在后台线程中。
具体的插件需要实现下面接口：

参见: CConnecterThread CFrmViewer

在文件 Connect.h 第 44 行定义.

成员枚举类型说明

◆ OnInitReturnValue

enum class CConnect::OnInitReturnValue

strongprotected

在文件 Connect.h 第 94 行定义.

构造及析构函数说明

◆ CConnect()

CConnect::CConnect ( CConnecter * pConnecter )

explicit

参数

pConnecter
parent

◆ ~CConnect()

CConnect::~CConnect ( )

overridevirtual

在文件 Connect.cpp 第 14 行定义.

成员函数说明

◆ Connect

int CConnect::Connect ( )

virtualslot

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

注解

如果连接是异步的，连接成功后触发 sigConnected() 。
如果连接是同步的，则在此函数成功调用后，触发 sigConnected() 。

返回

= 0: success
< 0: error

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

在文件 Connect.cpp 第 77 行定义.

◆ Disconnect

int CConnect::Disconnect ( )

virtualslot

断开

返回: 0: success; other error

参见: sigDisconnected()

在文件 Connect.cpp 第 89 行定义.

◆ OnClean()

virtual int CConnect::OnClean ( )

protectedpure virtual

清理

参见: Disconnect()

在 CConnectFreeRDP, CConnectLibVNCServer, CConnectPlayer , 以及 CConnectVnc 内被实现.

◆ OnInit()

virtual OnInitReturnValue CConnect::OnInit ( )

protectedpure virtual

具体的插件实现连接初始化

返回

< 0: 错误
= 0: 使用 OnProcess() (非 Qt 事件循环)
> 0: 不使用 OnProcess() (qt 事件循环)

参见: Connect()

在 CConnectFreeRDP, CConnectLibVNCServer, CConnectPlayer , 以及 CConnectVnc 内被实现.

◆ OnProcess()

int CConnect::OnProcess ( )

protectedvirtual

插件连接的具体操作处理

返回

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

参见: Connect() slotTimeOut()

被 CConnectFreeRDP, CConnectLibVNCServer , 以及 CConnectVnc 重载.

在文件 Connect.cpp 第 127 行定义.

◆ SetConnecter()

int CConnect::SetConnecter ( CConnecter * pConnecter )

private

在文件 Connect.cpp 第 19 行定义.

◆ sigBlockInputDialog

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

signal

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

参见: CConnecter::slotBlockInputDialog() SetConnecter

◆ sigBlockShowMessageBox

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

signal

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

参见: CConnecter::slotBlockShowMessageBox() SetConnecter

◆ sigBlockShowWidget

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

signal

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

参见: CConnecter::slotBlockShowWidget() SetConnecter

◆ sigDisconnected

void CConnect::sigDisconnected ( )

signal

断开连接成功信号。仅由插件触发

参见: Disconnect

◆ sigInformation

void CConnect::sigInformation ( const QString & szInfo )

signal

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

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

参见: sigShowMessageBox SetConnecter CConnecter::sigInformation()

◆ sigShowMessageBox

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

signal

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

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

参见: sigInformation SetConnecter CConnecter::sigShowMessageBox()

◆ slotTimeOut

void CConnect::slotTimeOut ( )

protectedvirtualslot

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

参见: Connect() OnProcess()

在文件 Connect.cpp 第 97 行定义.

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

/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/Connect.h
/home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/Connect.cpp

Public 槽

信号

Public 成员函数

Protected 类型

Protected 槽

Protected 成员函数

Private 成员函数

详细描述

成员枚举类型说明

◆ OnInitReturnValue

构造及析构函数说明

◆ CConnect()

◆ ~CConnect()

成员函数说明

◆ Connect

◆ Disconnect

◆ OnClean()

◆ OnInit()

◆ OnProcess()

◆ SetConnecter()

◆ sigBlockInputDialog

◆ sigBlockShowMessageBox

◆ sigBlockShowWidget

◆ sigDisconnected

◆ sigInformation

◆ sigShowMessageBox

◆ slotTimeOut