CBackendTemplateServer Class Reference

Inheritance diagram for CBackendTemplateServer:

Collaboration diagram for CBackendTemplateServer:

Public Slots
void	slotDisconnect (const QString &szIp, const quint16 port) override
Public Slots inherited from CBackendServer
virtual void	slotDisconnect (const QString &szIp, const quint16 port)=0
	Disconnect client.

Public Member Functions
	CBackendTemplateServer (COperateTemplateServer *pOperate=nullptr, bool bStopSignal=true)
Public Member Functions inherited from CBackendServer
	CBackendServer (COperateServer *pOperate=nullptr, bool bStopSignal=true)
Public Member Functions inherited from CBackend
	CBackend (COperate *pOperate=nullptr, bool bStopSignal=true)
	CBackend.
virtual int	Start ()
	Start.
virtual int	Stop ()
	Stop.
virtual int	WakeUp ()
	Wake up backend thread(background thread).

Protected Member Functions
virtual OnInitReturnValue	OnInit () override
	Initialization.
virtual int	OnClean () override
	Clean.
virtual int	OnProcess () override
	Specific operation processing of plug-in.

Additional Inherited Members
Signals inherited from 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
Signals inherited from CBackend
void	sigRunning ()
	Emitted when the plugin is successfully started.
void	sigStop ()
	Notify the user to stop.
void	sigFinished ()
	Successful stopped signal.
void	sigError (const int nError, const QString &szError=QString())
	Triggered when an error is generated.
void	sigInformation (const QString &szInfo)
	Triggering from a background thread displays information in the main thread without blocking the background thread.
void	sigShowMessageBox (const QString &szTitle, const QString &szMessage, 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	sigBlockShowMessageBox (const QString &szTitle, const QString &szMessage, QMessageBox::StandardButtons buttons, QMessageBox::StandardButton &nRet, bool &checkBox, QString checkBoxContext=QString())
	Block background threads and display message dialogs in foreground threads (QMessageBox)
void	sigBlockInputDialog (const QString &szTitle, const QString &szLable, const QString &szMessage, QString &szText)
	Block background threads and display input dialogs in foreground threads (QInputDialog)
void	sigBlockShowWidget (const QString &className, int &nRet, void *pContext)
	Blocks the background thread and displays the window in the foreground thread.
void	sigSecurityLevel (CSecurityLevel::Levels level)
	Triggered when the security level changes.
Protected Types inherited from CBackend
enum class	OnInitReturnValue { Fail = -1 , Success = 0 , UseOnProcess = Success , NotUseOnProcess = 1 }
Protected Slots inherited from CBackend
virtual void	slotTimeOut ()
	a non-Qt event loop (that is, normal loop processing)， It call OnProcess(), and start timer.

Detailed Description

Definition at line 8 of file BackendTemplateServer.h.

Constructor & Destructor Documentation

~CBackendTemplateServer()

CBackendTemplateServer::~CBackendTemplateServer ( )

virtual

Definition at line 15 of file BackendTemplateServer.cpp.

Member Function Documentation

OnClean()

int CBackendTemplateServer::OnClean ( )

overrideprotectedvirtual

Clean.

See also

Stop()

Implements CBackend.

Definition at line 44 of file BackendTemplateServer.cpp.

OnInit()

CBackend::OnInitReturnValue CBackendTemplateServer::OnInit ( )

overrideprotectedvirtual

Initialization.

Returns

CBackend::OnInitReturnValue

• OnInitReturnValue::Fail: error
• OnInitReturnValue::Success/OnInitReturnValueUseOnProcess: Use OnProcess() (non-Qt event loop)
• OnInitReturnValue::NotUseOnProcess: Don't use OnProcess() (qt event loop)

See also

Start()

Implements CBackend.

Definition at line 36 of file BackendTemplateServer.cpp.

OnProcess()

int CBackendTemplateServer::OnProcess ( )

overrideprotectedvirtual

Specific operation processing of plug-in.

Returns

• >= 0: continue, Interval call time (msec)
• = -1: stop
• < -1: error code

See also

Start() slotTimeOut()

Reimplemented from CBackend.

Definition at line 67 of file BackendTemplateServer.cpp.

slotDisconnect

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

overrideslot

Definition at line 76 of file BackendTemplateServer.cpp.

---

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

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