服务操作接口更多...

#include <OperateServer.h>

类 COperateServer 继承关系图:

[图例]

COperateServer 的协作图:

[图例]

Public 成员函数
	COperateServer (CPlugin *plugin)

virtual QWidget *	GetViewer () override
	得到显示视图

virtual int	Start () override
	开始

virtual int	Stop () override
	关闭

Public 成员函数继承自 COperate
	COperate (CPlugin *plugin)

virtual int	OpenDialogSettings (QWidget *parent=nullptr)
	打开设置对话框

virtual QMenu *	GetMenu (QWidget *parent=nullptr)
	Get menu

virtual const QString	Id ()
	标识

virtual const QString	Name ()
	名称

virtual const QString	Description ()
	描述

virtual const QString	Protocol () const
	协议

virtual const qint16	Version () const =0
	版本

virtual const QIcon	Icon () const
	图标

virtual const QString	GetTypeName () const
	类型名

virtual QString	GetSettingsFile ()

virtual int	SetSettingsFile (const QString &szFile)

virtual CStats *	GetStats ()
	得到统计信息。如果有，其派生类则需要重载此函数提供统计信息。

virtual CSecurityLevel::Levels	GetSecurityLevel () const
	Get Security Level

Protected 成员函数
virtual Q_INVOKABLE CBackend *	InstanceBackend ()=0
	新建后端实例。它的所有者是调用者，如果调用者不再使用它，调用者必须负责释放它。

virtual Q_INVOKABLE int	Initial () override
	Initial parameters and resource

virtual Q_INVOKABLE int	Clean () override
	Clean parameters and resource

Protected 成员函数继承自 COperate
virtual Q_INVOKABLE int	SetPluginParameters (CParameterPlugin *pPara)=0
	应用插件全局参数

Q_INVOKABLE CPlugin *	GetPlugin () const
	Get plugin

virtual Q_INVOKABLE int	Load (QSettings &set)=0
	加载参数

virtual Q_INVOKABLE int	Save (QSettings &set)=0
	保存参数

virtual Q_INVOKABLE int	Load (QString szFile=QString())
	从文件中加载参数

virtual Q_INVOKABLE int	Save (QString szFile=QString())
	保存参数到文件中

Private 槽
void	slotStart (bool checked)

Private 属性
CFrmViewServer *	m_pViewer

CBackendThread *	m_pThread

QAction *	m_pActionStart

额外继承的成员函数
信号继承自 COperate
void	sigViewerFocusIn (QWidget *pView)
	视图获得焦点

void	sigFullScreen (bool bFullScreen)
	全屏。由操作触发

void	sigUpdateName (const QString &szName)

void	sigUpdateParameters (COperate *pOperate)
	更新参数，通知应用程序保存或显示参数

void	sigError (const int nError, const QString &szError)
	当有错误产生时触发。

void	sigInformation (const QString &szInfo)
	中主窗口中显示信息

void	sigShowMessageBox (const QString &title, const QString &message, const QMessageBox::Icon &icon=QMessageBox::Information)
	从后台线程中触发在主线程中显示消息对话框(QMessageBox)，不阻塞后台线程

void	sigClipBoardChanged ()

void	sigSecurityLevel ()
	当安全级别改变时触发。其派生类不要直接触发，需要使用 slotSetSecurityLevel 触发

void	sigRunning ()
	开始成功信号。仅由插件触发。

void	sigStop ()
	通知用户停止。仅由插件触发。当从插件中需要停止时触发。例如：对端断开连接、重置连接或者连接出错。当应用接收到此信号后，调用 Stop() 关闭连接。

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

Protected 槽继承自 COperate
void	slotUpdateName ()

void	slotSetSecurityLevel (CSecurityLevel::Levels level)

静态 Protected 成员函数继承自 COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object

Protected 属性继承自 COperate
QMenu	m_Menu

QAction *	m_pActionSettings

详细描述

服务操作接口

注解

此接口仅由插件实现。
此接口实例运行在主线程(UI线程)中。
具体的插件需要实现下面接口：

实现 InstanceBackend() ，生成连接对象。连接对象运行在后台线程中。

参见: CFrmViewServer CBackendServer

在文件 OperateServer.h 第 38 行定义.

构造及析构函数说明

◆ ~COperateServer()

COperateServer::~COperateServer ( )

virtual

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

成员函数说明

◆ Clean()

int COperateServer::Clean ( )

overrideprotectedvirtual

Clean parameters and resource

参见: CManager::DeleteOperate

重载 COperate .

被 COperateFreeRDPServer, COperateFtpServer, COperateSftpServer , 以及 COperateTemplateServer 重载.

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

◆ GetViewer()

QWidget * COperateServer::GetViewer ( )

overridevirtual

得到显示视图

返回: QWidget*: 视图指针。它的所有者是本类或其派生类的实例

注解: 如果自己实现视图，则需要在开始时禁用视图，在　sigRunning　后允许视图。

参见: sigRunning CFrmViewer::CFrmViewer

实现了 COperate.

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

◆ Initial()

int COperateServer::Initial ( )

overrideprotectedvirtual

Initial parameters and resource

注解: Call before Load()

参见: CManager::CreateOperate Load

重载 COperate .

被 COperateFreeRDPServer, COperateFtpServer, COperateSftpServer , 以及 COperateTemplateServer 重载.

在文件 OperateServer.cpp 第 29 行定义.

◆ InstanceBackend()

virtual Q_INVOKABLE CBackend * COperateServer::InstanceBackend ( )

protectedpure virtual

新建后端实例。它的所有者是调用者，如果调用者不再使用它，调用者必须负责释放它。

在 COperateSftpServer, COperateFreeRDPServer, COperateFtpServer , 以及 COperateTemplateServer 内被实现.

◆ slotStart

void COperateServer::slotStart ( bool checked )

privateslot

在文件 OperateServer.cpp 第 88 行定义.

◆ Start()

int COperateServer::Start ( )

overridevirtual

开始

注解: 仅由用户调用，插件不能直接调用此函数。插件开始成功后，触发信号 sigRunning()

参见: sigRunning()

实现了 COperate.

在文件 OperateServer.cpp 第 66 行定义.

◆ Stop()

int COperateServer::Stop ( )

overridevirtual

关闭

注解: 仅由用户调用，插件不能直接调用此函数。插件停止成功后，触发信号 sigFinished()。调用者收到信号后，删除对象

参见: sigFinished()

实现了 COperate.

在文件 OperateServer.cpp 第 73 行定义.

类成员变量说明

◆ m_pActionStart

QAction* COperateServer::m_pActionStart

private

在文件 OperateServer.h 第 71 行定义.

◆ m_pThread

CBackendThread* COperateServer::m_pThread

private

在文件 OperateServer.h 第 69 行定义.

◆ m_pViewer

CFrmViewServer* COperateServer::m_pViewer

private

在文件 OperateServer.h 第 68 行定义.

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

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

Public 成员函数

Protected 成员函数

Private 槽

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~COperateServer()

成员函数说明

◆ Clean()

◆ GetViewer()

◆ Initial()

◆ InstanceBackend()

◆ slotStart

◆ Start()

◆ Stop()

类成员变量说明

◆ m_pActionStart

◆ m_pThread

◆ m_pViewer