COperateServer Class Reference

Server operate interface. More...

#include <OperateServer.h>

Inheritance diagram for COperateServer:

Collaboration diagram for COperateServer:

Public Member Functions
	COperateServer (CPlugin *plugin)
virtual QWidget *	GetViewer () override
	Get Viewer.
virtual int	Start () override
	Start.
virtual int	Stop () override
	Stop.
Public Member Functions inherited from COperate
	COperate (CPlugin *plugin)
virtual int	OpenDialogSettings (QWidget *parent=nullptr)
	Open settings dialog.
virtual QMenu *	GetMenu (QWidget *parent=nullptr)
	Get menu.
virtual const QString	Id ()
virtual const QString	Name ()
	Name.
virtual const QString	Description ()
	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 ()
	Get statistics.
virtual CSecurityLevel::Levels	GetSecurityLevel () const
	Get Security Level.

Protected Member Functions
virtual Q_INVOKABLE CBackend *	InstanceBackend ()=0
	New CBackend.
virtual Q_INVOKABLE int	Initial () override
	Initial parameters and resource.
virtual Q_INVOKABLE int	Clean () override
	Clean parameters and resource.
Protected Member Functions inherited from COperate
virtual Q_INVOKABLE int	SetPluginParameters (CParameterPlugin *pPara)=0
	Apply the parameters of the plug-in.
Q_INVOKABLE CPlugin *	GetPlugin () const
	Get plugin.
virtual Q_INVOKABLE int	Load (QSettings &set)=0
	Load parameters.
virtual Q_INVOKABLE int	Save (QSettings &set)=0
	Save parameters.
virtual Q_INVOKABLE int	Load (QString szFile=QString())
	Load parameters from file.
virtual Q_INVOKABLE int	Save (QString szFile=QString())
	Save parameters to file.

Private Slots
void	slotStart (bool checked)

Private Attributes
CFrmViewServer *	m_pViewer
CBackendThread *	m_pThread
QAction *	m_pActionStart

Additional Inherited Members
Signals inherited from COperate
void	sigViewerFocusIn (QWidget *pView)
	The view is focus.
void	sigFullScreen (bool bFullScreen)
	Full screen.
void	sigUpdateName (const QString &szName)
void	sigUpdateParameters (COperate *pOperate)
	Update parameters, notify application to save or show parameters.
void	sigError (const int nError, const QString &szError)
	Triggered when an error is generated.
void	sigInformation (const QString &szInfo)
	Show information in main windows.
void	sigShowMessageBox (const QString &title, const QString &message, const QMessageBox::Icon &icon=QMessageBox::Information)
	Trigger the display of a message dialog (QMessageBox) in the main thread from a background thread without blocking the background thread.
void	sigClipBoardChanged ()
void	sigSecurityLevel ()
	Triggered when the security level changes.
void	sigRunning ()
	Start success signal.
void	sigStop ()
	Notify the user to stop.
void	sigFinished ()
	Successful disconnection signal.
Protected Slots inherited from COperate
void	slotUpdateName ()
void	slotSetSecurityLevel (CSecurityLevel::Levels level)
Static Protected Member Functions inherited from COperate
static QObject *	createObject (const QString &className, QObject *parent=NULL)
	Create Object.
Protected Attributes inherited from COperate
QMenu	m_Menu
QAction *	m_pActionSettings

Detailed Description

Server operate interface.

Note

The interface only is implemented by plug-in
The specific plug-in needs to implement the following interface.

1. Implement InstanceConnect() . Generate a connection object. The connection object runs in a background thread.

See also

CFrmViewServer CBackendServer

Definition at line 38 of file OperateServer.h.

Constructor & Destructor Documentation

~COperateServer()

COperateServer::~COperateServer ( )

virtual

Definition at line 19 of file OperateServer.cpp.

Member Function Documentation

Clean()

int COperateServer::Clean ( )

overrideprotectedvirtual

Clean parameters and resource.

See also

CManager::DeleteOperate

Reimplemented from COperate.

Reimplemented in COperateFreeRDPServer, COperateFtpServer, COperateSftpServer, and COperateTemplateServer.

Definition at line 55 of file OperateServer.cpp.

GetViewer()

QWidget * COperateServer::GetViewer ( )

overridevirtual

Get Viewer.

Returns

QWidget*: the ownership is a instance of this class or its derivative class

Note

If you implement the view yourself, you need to disable the view at the beginning and allow the view after sigRun.

See also

sigRunning CFrmViewer::CFrmViewer

Implements COperate.

Definition at line 24 of file OperateServer.cpp.

Initial()

int COperateServer::Initial ( )

overrideprotectedvirtual

Initial parameters and resource.

Note

Call before Load()

See also

CManager::CreateOperate Load

Reimplemented from COperate.

Reimplemented in COperateFreeRDPServer, COperateFtpServer, COperateSftpServer, and COperateTemplateServer.

Definition at line 29 of file OperateServer.cpp.

InstanceBackend()

virtual Q_INVOKABLE CBackend * COperateServer::InstanceBackend ( )

protectedpure virtual

New CBackend.

the ownership is caller. if don't use, the caller must delete it.

Implemented in COperateSftpServer, COperateFreeRDPServer, COperateFtpServer, and COperateTemplateServer.

slotStart

void COperateServer::slotStart ( bool  checked )

privateslot

Definition at line 88 of file OperateServer.cpp.

Start()

int COperateServer::Start ( )

overridevirtual

Start.

Note

Only call by user, The plugin don't call it. When plugin is started, it emit sigRunning()

See also

sigRunning()

Implements COperate.

Definition at line 66 of file OperateServer.cpp.

Stop()

int COperateServer::Stop ( )

overridevirtual

Stop.

Note

Only call by user, The plugin don't call it. When plugin is stopped, it emit sigFinished(). The caller receive the signal, then delete the object.

See also

sigFinished()

Implements COperate.

Definition at line 73 of file OperateServer.cpp.

Member Data Documentation

m_pActionStart

QAction* COperateServer::m_pActionStart

private

Definition at line 71 of file OperateServer.h.

m_pThread

CBackendThread* COperateServer::m_pThread

private

Definition at line 69 of file OperateServer.h.

m_pViewer

CFrmViewServer* COperateServer::m_pViewer

private

Definition at line 68 of file OperateServer.h.

---

The documentation for this class was generated from the following files:

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