CBackendTemplateServer类 参考

类 CBackendTemplateServer 继承关系图:

CBackendTemplateServer 的协作图:

Public 槽
void	slotDisconnect (const QString &szIp, const quint16 port) override
virtual int	WakeUp () override
	唤醒后台线程
Public 槽 继承自 CBackendServer
virtual void	slotDisconnect (const QString &szIp, const quint16 port)=0
	Disconnect client

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

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

额外继承的成员函数
信号 继承自 CBackendServer
void	sigConnected (const QString &szIp, const quint16 port)
	emit when new client connected
void	sigDisconnected (const QString &szIp, const quint16 port)
	emit when the client disconnected
信号 继承自 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)
	当安全级别改变时触发
Protected 类型 继承自 CBackend
enum class	OnInitReturnValue { Fail = -1 , Success = 0 , UseOnProcess = Success , NotUseOnProcess = 1 }
Protected 槽 继承自 CBackend
virtual void	slotTimeOut ()
	一个非 Qt 事件处理，它调用 OnProcess()，并根据其返回值开始新的定时器。 如果是不是一个非 Qt 事件循环（就是普通的循环处理）， 可以重载它，或者 OnInit() 返回值 OnInitReturnValue::NotUseOnProcess

详细描述

在文件 BackendTemplateServer.h 第 8 行定义.

构造及析构函数说明

~CBackendTemplateServer()

CBackendTemplateServer::~CBackendTemplateServer ( )

virtual

在文件 BackendTemplateServer.cpp 第 15 行定义.

成员函数说明

OnClean()

int CBackendTemplateServer::OnClean ( )

overrideprotectedvirtual

清理

参见

Stop()

实现了 CBackend.

在文件 BackendTemplateServer.cpp 第 55 行定义.

OnInit()

CBackend::OnInitReturnValue CBackendTemplateServer::OnInit ( )

overrideprotectedvirtual

初始化

返回

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

参见

Start()

实现了 CBackend.

在文件 BackendTemplateServer.cpp 第 47 行定义.

OnProcess()

int CBackendTemplateServer::OnProcess ( )

overrideprotectedvirtual

具体操作处理

返回

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

参见

Start() slotTimeOut()

重载 CBackend .

在文件 BackendTemplateServer.cpp 第 78 行定义.

slotDisconnect

void CBackendTemplateServer::slotDisconnect ( const QString & szIp, const quint16 port )

overrideslot

在文件 BackendTemplateServer.cpp 第 87 行定义.

WakeUp

int CBackendTemplateServer::WakeUp ( )

overridevirtualslot

唤醒后台线程

在文件 BackendTemplateServer.cpp 第 24 行定义.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Server/BackendTemplateServer.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Plugins/Template/Server/BackendTemplateServer.cpp