CParameterConnecter类 参考

连接参数接口。仅在插件内有效。 更多...

#include <ParameterConnecter.h>

类 CParameterConnecter 继承关系图:

信号
void	sigSetParameterClient ()
信号 继承自 CParameter
void	sigChanged ()
	当参数改变时，触发 通常如果需要，则相应的参数会对应一个改变事件。

Public 成员函数
	CParameterConnecter (QObject *parent=nullptr, const QString &szPrefix=QString())
CParameterClient *	GetParameterClient ()
	Get CParameterClient
int	SetParameterClient (CParameterClient *p)
Public 成员函数 继承自 CParameter
	CParameter (QObject *parent=nullptr, const QString &szPrefix=QString())
virtual int	Load (QString szFile=QString())
	Load from file
virtual int	Save (QString szFile=QString(), bool bForce=true)
	Save to file
virtual int	Load (QSettings &set)
	Load from storage
virtual int	Save (QSettings &set, bool bForce=true)
	Save to storage
virtual bool	CheckValidity ()
	检查参数是否有效，以决定是否使用或者保存参数。 派生类一般只要重载 OnCheckValidity() ，用于检查参数。

Protected 槽
virtual void	slotSetParameterClient ()
	设置 CParameterClient 后调用，用于初始化与 CParameterClient 有关的操作。

Protected 成员函数
QByteArray	PasswordSum (const std::string &password, const std::string &key)
int	LoadPassword (const QString &szTitle, const QString &szKey, QString &password, QSettings &set)
int	SavePassword (const QString &szKey, const QString &password, QSettings &set, bool bSave=false)
Protected 成员函数 继承自 CParameter
virtual int	OnLoad (QSettings &set)=0
virtual int	OnSave (QSettings &set)=0
virtual bool	OnCheckValidity ()
	检查参数是否有效
int	SetModified (bool bModified=true)
	在设置参数时，如果有修改，则调用。
bool	GetModified ()
	参数是否有修改

Private 属性
CParameterConnecter *	m_Parent
CParameterClient *	m_pParameterClient

额外继承的成员函数
属性 继承自 CParameter
bool	Modified

详细描述

连接参数接口。仅在插件内有效。

注解

• 仅在插件中实现和使用
• 应用程序不能访问，只能通过 CConnecter::OpenDialogSettings 进行设置。
• 插件通过 CConnecterThread::GetParameter() 访问连接参数
• 使用连接基础参数
• 需要访问客户端参数 (CFrmParameterClient) 的分类，需要从此类派生。 通过调用 CParameterConnecter::GetParameterClient() 访问客户端参数(CParameterClient)

使用客户端库参数 (CParameterClient)

为连接参数 ( CParameterConnecter 或其派生类 ) 设置客户端库参数 (CParameterClient)

• 如果连接参数 ( CParameterConnecter 或其派生类 ) 需要客户端库参数 (CParameterClient) 。
  • 请在 CConnecter 派生类的构造函数中实例化连接参数。例如：

        CParameterFreeRDP m_ParameterFreeRdp;

  • 调用 CConnecter::SetParameter 设置参数指针。例如：

    CConnecterFreeRDP::CConnecterFreeRDP(CPluginClient *plugin)
        : CConnecterThread(plugin)
    {
        qDebug(log) << Q_FUNC_INFO;
        //WLog_SetLogLevel(WLog_GetRoot(), WLOG_TRACE);
     
        // 在 freerdp_client_context_free 中释放
        //m_ParameterFreeRdp.m_pSettings = freerdp_settings_new(0);
    }

  • 默认会自动为连接参数设置 CParameterClient 。详见: CClient::CreateConnecter 。

    CConnecter* CClient::CreateConnecter(const QString& id)
    {
        auto it = m_Plugins.find(id);
        if(m_Plugins.end() != it)
        {
            bool bRet = 0;
            qDebug(log) << "CreateConnecter id:" << id;
            auto plugin = it.value();
            CConnecter* p = nullptr;
            if(plugin) {
                //p = plugin->CreateConnecter(id);
                bRet = QMetaObject::invokeMethod(
                    plugin,
                    "CreateConnecter",
                    Qt::DirectConnection,
                    Q_RETURN_ARG(CConnecter*, p),
                    Q_ARG(QString, id));
                if(!bRet) {
                    qCritical(log) << "Create CConnecter fail.";
                    return nullptr;
                }
            }
            if(p) {
                int val = 0;
                //p->Initial();
                bRet = QMetaObject::invokeMethod(
                    p,
                    "Initial",
                    Qt::DirectConnection,
                    Q_RETURN_ARG(int, val));
                if(!bRet || val) {
                    qCritical(log) << "Connecter initial fail" << bRet << val;
                    DeleteConnecter(p);
                    return nullptr;
                }
                //p->SetParameterClient(m_ParameterClient)
                bRet = QMetaObject::invokeMethod(
                    p,
                    "SetParameterClient",
                    Qt::DirectConnection,
                    Q_RETURN_ARG(int, val),
                    Q_ARG(CParameterClient*, m_pParameterClient));
                if(!bRet || val) {
                    qCritical(log) << "SetParameterClient fail" << bRet << val;
                    DeleteConnecter(p);
                    return nullptr;
                }
            }
            return p;
        }
        return nullptr;
    }

  • 如果参数不需要 CParameterClient ， 那请在 CConnecter 派生类重载 CConnecter::SetParameterClient 不设置它。

在连接参数 ( CParameterConnecter 或其派生类 ) 中使用客户端库参数 (CParameterClient)

• 在连接参数 ( CParameterConnecter 或其派生类 ) 使用 CParameterConnecter::GetParameterClient() 来得到客户端库参数 (CParameterClient) 。
• 连接参数 ( CParameterConnecter 或其派生类 ) 使用客户端库参数 (CParameterClient) 的值做为其初始值。 请重载 CParameterConnecter::slotSetParameterClient 并在其中初始化相关的值。
  例如：是否保存密码以 CParameterClient 的成员值做为其初始化值。

  void CParameterUser::slotSetParameterClient()
  {
      if(!GetParameterClient()) {
          QString szErr = "The CParameterClient is null";
          qCritical(log) << szErr;
          Q_ASSERT_X(false, "CParameterUser", szErr.toStdString().c_str());
          return;
      }
   
      if(GetParameterClient())
      {
          if(GetParameterClient()->GetEnableSystemUserToUser())
              SetUser(RabbitCommon::CTools::GetCurrentUser());
          SetSavePassword(GetParameterClient()->GetSavePassword());
          SetSavePassphrase(GetParameterClient()->GetSavePassword());
      }
   
      return;
  }

  参见

  CParameterUser::OnLoad

连接参数分类使用

因为可能会有很多参数，所以需要按参数类型分类。每个分类可以从此类派生出一个单独的类。
因为连接参数都有一些基本的参数（例如网络地址等），所以插件的连接参数从 CParameterBase 派生。 而每个分类做为它的成员变量。

例如：
连接参数包括以下几种类型：

• 基本参数

  class CParameterBase : public CParameterConnecter

• 用户参数

  class CParameterUser : public CParameterConnecter

• 视频参数

  class CParameterVideo : public CParameter

• 音频参数

  class CParameterAudio : public CParameter

其中 CParameterBase ， CParameterUser 它需要 CFrmParameterClient ， 所以必须从 CParameterConnecter 派生。 其它的类型则不需要，所以从 CParameter 派生。

那么连接参数可以是以上类型的集合：

class CParameterConnect : public CParameterBase
{
public:
    explicit CParameterConnect(CParameterConnecter *parent = nullptr);
 
    CParameterUser m_User;
    CParameterVideo m_Video;
    CParameterAudio m_Audio;
};
 
CParameterConnect::CParameterConnect(CParameterConnecter *parent = nullptr)
 : CParameterBase(parent),
   m_User(this, "Host"),
   m_Video(this),
   m_Audio(this)
{}

注解

• 连接参数必须从 CParameterBase 派生
• 当成员实例化时
  • CParameterUser 必须设置构造函数的参数 parent 为 CParameterConnecter 的实例（一般设置为 this）。
  • m_Video ， m_Audio 必须设置构造函数的参数 parent 为 CParameter 或其派生类的实例（一般设置为 this）。
• 为连接参数 ( CParameterConnecter 或其派生类 ) 设置客户端库参数 (CParameterClient)

参见

CParameterBase CClient::CreateConnecter CConnecter::CConnecter CConnecter::SetParameterClient CConnecter::SetParameter CParameterClient CParameterConnecter::GetParameterClient

在文件 ParameterConnecter.h 第 255 行定义.

成员函数说明

GetParameterClient()

CParameterClient * CParameterConnecter::GetParameterClient

(

)

Get CParameterClient

在文件 ParameterConnecter.cpp 第 32 行定义.

LoadPassword()

int CParameterConnecter::LoadPassword ( const QString &  szTitle, const QString &  szKey, QString &  password, QSettings &  set  )

protected

在文件 ParameterConnecter.cpp 第 64 行定义.

PasswordSum()

QByteArray CParameterConnecter::PasswordSum ( const std::string &  password, const std::string &  key  )

protected

在文件 ParameterConnecter.cpp 第 51 行定义.

SavePassword()

int CParameterConnecter::SavePassword ( const QString &  szKey, const QString &  password, QSettings &  set, bool  bSave = false  )

protected

在文件 ParameterConnecter.cpp 第 101 行定义.

SetParameterClient()

int CParameterConnecter::SetParameterClient

(

CParameterClient *

p

)

在文件 ParameterConnecter.cpp 第 38 行定义.

slotSetParameterClient

void CParameterConnecter::slotSetParameterClient ( )

protectedvirtualslot

设置 CParameterClient 后调用，用于初始化与 CParameterClient 有关的操作。

在连接参数 ( CParameterConnecter 或其派生类 ) 中使用客户端库参数 (CParameterClient)

被 CParameterBase 重载.

在文件 ParameterConnecter.cpp 第 46 行定义.

类成员变量说明

m_Parent

CParameterConnecter* CParameterConnecter::m_Parent

private

在文件 ParameterConnecter.h 第 291 行定义.

m_pParameterClient

CParameterClient* CParameterConnecter::m_pParameterClient

private

参见

CClient::CreateConnecter CConnecter::SetParameterClient

在文件 ParameterConnecter.h 第 295 行定义.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/ParameterConnecter.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Client/ParameterConnecter.cpp