插件接口

插件接口. 更多...

插件接口 的协作图:

模块
	桌面类
	终端类

类
class	CBackend
	后端接口。它由协议插件实现。 它默认启动一个定时器来开启一个非 Qt 事件循环（就是普通的循环处理）。 详见： Start()、 slotTimeOut()、 OnProcess() 。 当然，它仍然支持 Qt 事件（QObject 的 信号 － 槽 机制）。 更多...
class	CBackendThread
	The backend thread 更多...
class	CFrmScroll
	The scroll form class 更多...
class	CFrmViewer
	用于显示从 CConnectDesktop 输出的图像，和向 CConnectDesktop 发送键盘、鼠标事件。 更多...
class	CManager
	管理插件 更多...
class	COperate
	操作接口。 更多...
class	CParameter
	参数接口 更多...

详细描述

插件接口.

• 线程模型：
  • 阻塞：大多数控制协议实现库连接都是阻塞的。所以需要一个线程处理一个连接。

    参见

    CPluginClient COperateThread

  • 非阻塞：例如Qt事件。一个线程可以处理多个连接。
    • 插件没有后台线程，所有连接使用主线程
    • 插件有一个后台线程，所有连接使用同一个后台线程

      参见

      CPluginClientThread COperateDesktop

• 类关系：
• 序列图：
• 写一个插件：
  • 生成插件目标名称格式为： PluginClient${PROJECT_NAME}

    # Author: Kang Lin <kl222@126.com>
     
    project(FreeRDP
        DESCRIPTION "FreeRDP client plugin"
        )
     
    SET(FreeRDP_LIBS freerdp-client freerdp winpr Plugin)
     
    SET(FreeRDP_SOURCE_FILES
        ParameterFreeRDP.cpp
        PluginFreeRDP.cpp
        BackendFreeRDP.cpp
        OperateFreeRDP.cpp
        DlgSetFreeRDP.cpp
        ConvertKeyCode.cpp
        CursorFreeRDP.cpp
        ClipboardFreeRDP.cpp
        ClipboardMimeData.cpp
        DlgGetUserPasswordFreeRDP.cpp
        DlgDesktopSize.cpp
        )
     
    SET(FreeRDP_HEADER_FILES
        ParameterFreeRDP.h
        PluginFreeRDP.h
        BackendFreeRDP.h
        OperateFreeRDP.h
        DlgSetFreeRDP.h
        ConvertKeyCode.h
        CursorFreeRDP.h
        ClipboardFreeRDP.h
        ClipboardMimeData.h
        DlgGetUserPasswordFreeRDP.h
        DlgDesktopSize.h
        )
     
    SET(FreeRDP_UI_FILES
        DlgSetFreeRDP.ui
        DlgGetUserPasswordFreeRDP.ui
        DlgDesktopSize.ui
        )
     
    find_package(FreeRDP)
    if(FreeRDP_VERSION_MAJOR VERSION_GREATER_EQUAL 3)
        list(APPEND FreeRDP_HEADER_FILES ConnectLayer.h ConnectLayerQTcpSocket.h)
        list(APPEND FreeRDP_SOURCE_FILES ConnectLayer.cpp ConnectLayerQTcpSocket.cpp)
     
        find_package(libssh)
        if(libssh_FOUND)
            list(APPEND FreeRDP_HEADER_FILES ConnectLayerSSHTunnel.h)
            list(APPEND FreeRDP_SOURCE_FILES ConnectLayerSSHTunnel.cpp)
        endif()
    endif()
     
    if(WIN32)
        list(APPEND FreeRDP_LIBS Credui.dll)
    endif()
    if(MINGW)
        set(FreeRDP_OPTIONS -fpermissive)
    endif()
     
    set(FreeRDP_QT_COMPONENTS Widgets Multimedia PrintSupport SerialPort)
    find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS ${FreeRDP_QT_COMPONENTS})
    if(Qt${QT_VERSION_MAJOR}_FOUND)
        FOREACH(_COMPONENT ${FreeRDP_QT_COMPONENTS})
            list(APPEND FreeRDP_LIBS Qt${QT_VERSION_MAJOR}::${_COMPONENT})
        ENDFOREACH()
    endif()
    ADD_PLUGIN_TARGET(NAME PluginClient${PROJECT_NAME}
        ISPLUGIN
        SOURCE_FILES ${FreeRDP_SOURCE_FILES} ${FreeRDP_HEADER_FILES} ${FreeRDP_UI_FILES}
        PRIVATE_LIBS ${FreeRDP_LIBS}
        PRIVATE_INCLUDE_DIRS ${FreeRDP_INCLUDE_DIR} ${WinPR_INCLUDE_DIR}
        PRIVATE_DEFINITIONS ${FreeRDP_DEFINITIONS}
           PluginFreeDP_VERSION="${RabbitRemoteControl_VERSION}"
        PRIVATE_OPTIONS ${FreeRDP_OPTIONS}
        INSTALL_DIR ${PLUGIN_PATH}
        OUTPUT_DIR ${CMAKE_BINARY_DIR}/${PLUGIN_PATH}
        INSTALL_RPATH ${INSTALL_RPATH}
        VERSION ${RabbitRemoteControl_VERSION}
        )

  • 实现插件接口 CPluginClient
    • 如果没有后台线程，或者是阻塞线程模型（一个后台线程处理一个连接。连接是阻塞的）。例如：FreeRDP
      • 从 CPluginClient 派生插件。例如： CPluginFreeRDP
        • 在类声明中实现Qt接口:

              Q_INTERFACES(CPlugin)
           
          #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
              Q_PLUGIN_METADATA(IID CPlugin_iid)
          #endif

        • 在构造函数中初始化操作。例如：初始化资源等
        • 在析构函数中释放资源。
        • 实现属性、函数
          • 插件名：必须与工程名（翻译资源文件名[.ts]）相同。 例如： CPluginFreeRDP::Name()

            // Author: Kang Lin <kl222@126.com>
             
            #include "PluginFreeRDP.h"
            #include "OperateFreeRDP.h"
            #include "winpr/wlog.h"
             
            #include <QLoggingCategory>
             
            #ifdef HAVE_LIBSSH
                #include "ChannelSSHTunnel.h"
            #endif
             
            #include "freerdp/version.h"
             
            static Q_LOGGING_CATEGORY(log, "FreeRDP.Plugin")
            static Q_LOGGING_CATEGORY(LoggerFreeRDP, "FreeRDP.Log")
            static Q_LOGGING_CATEGORY(LoggerFreeRDPTrace, "FreeRDP.Log.Trace")
            static Q_LOGGING_CATEGORY(LoggerFreeRDPFatal, "FreeRDP.Log.Fatal")
             
            CPluginFreeRDP::CPluginFreeRDP(QObject *parent)
                : CPlugin(parent)
            {
                qDebug(log) << Q_FUNC_INFO;
                qInfo(log) << "FreeRDP version:" << freerdp_get_version_string()
                                    << "revision:" << freerdp_get_build_revision();
             
                static wLogCallbacks* pCbLog = new wLogCallbacks;
                BOOL bRet = WLog_SetLogAppenderType(WLog_GetRoot(), WLOG_APPENDER_CALLBACK);
                if(bRet && pCbLog)
                {
                    memset(pCbLog, 0, sizeof(wLogCallbacks));
                    pCbLog->message = [](const wLogMessage* msg)->BOOL{
                        switch(msg->Level)
                        {
                        case WLOG_TRACE:
                            qDebug(LoggerFreeRDPTrace) /*<< msg->PrefixString */ << msg->TextString;
                            break;
                        case WLOG_DEBUG:
                            qDebug(LoggerFreeRDP) /*<< msg->PrefixString */ << msg->TextString;
                            break;
                        case WLOG_INFO:
                            qInfo(LoggerFreeRDP) /*<< msg->PrefixString*/ << msg->TextString;
                            break;
                        case WLOG_WARN:
                            qWarning(LoggerFreeRDP) /*<< msg->PrefixString */<< msg->TextString;
                        case WLOG_ERROR:
                            qCritical(LoggerFreeRDP) /*<< msg->PrefixString*/ << msg->TextString;
                            break;
                        case WLOG_FATAL:
                        case WLOG_OFF:
                            qCritical(LoggerFreeRDPFatal) /*<< msg->PrefixString*/ << msg->TextString;
                            break;
                        default:
                            break;
                        }
                        return TRUE;
                    };
                    WLog_ConfigureAppender(WLog_GetLogAppender(WLog_GetRoot()), "callbacks", pCbLog);
                }
                WLog_SetLogLevel(WLog_GetRoot(), WLOG_TRACE);
            }
             
            CPluginFreeRDP::~CPluginFreeRDP()
            {
                qDebug(log) << Q_FUNC_INFO;
            }
             
            const CPlugin::TYPE CPluginFreeRDP::Type() const
            {
                return TYPE::RemoteDesktop;
            }
             
            const QString CPluginFreeRDP::Name() const
            {
                return "FreeRDP";
            }
             
            const QString CPluginFreeRDP::DisplayName() const
            {
                return tr("Free remote desktop protocol");
            }
             
            const QString CPluginFreeRDP::Description() const
            {
                return tr("RDP(Remote desktop Protocol): Access remote desktops such as windows.") + "\n"
                       + tr("It uses FreeRDP: https://github.com/FreeRDP/FreeRDP/");
            }
             
            const QString CPluginFreeRDP::Protocol() const
            {
                return "RDP";
            }
             
            const QIcon CPluginFreeRDP::Icon() const
            {
                return QIcon::fromTheme("windows");
            }
             
            const QString CPluginFreeRDP::Version() const
            {
                return PluginFreeDP_VERSION;
            }
             
            const QString CPluginFreeRDP::Details() const
            {
                QString szDetails;
                szDetails = "- " + tr("FreeRDP");
                szDetails += "\n";
                szDetails += "  - " + tr("version: ");
                szDetails += freerdp_get_version_string();
                szDetails += "\n";
                szDetails += "  - " + tr("Build version: ");
                szDetails += freerdp_get_build_revision();
                szDetails += ":";
                szDetails += freerdp_get_build_revision();
                szDetails += "\n";
            #if FREERDP_VERSION_MAJOR < 3
                szDetails += "  - " + tr("Build date: ");
                szDetails += freerdp_get_build_date();
                szDetails += "\n";
            #endif
                szDetails += "  - ";
                szDetails += freerdp_get_build_config();
             
            #ifdef HAVE_LIBSSH
                CChannelSSH channel(nullptr, nullptr);
                szDetails += channel.GetDetails();
            #endif
             
                return szDetails;
            }
             
            COperate *CPluginFreeRDP::OnCreateOperate(const QString &szId)
            {
                if(Id() == szId)
                    return new COperateFreeRDP(this);
             
                return nullptr;
            }

    • 如果非阻塞线程模型。一个后台线程处理多个连接。连接是非阻塞的。(暂时未用)
      • 从 CPluginClientThread 派生插件。
        • 在类声明中实现Qt接口:

              Q_INTERFACES(CPlugin)
           
          #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
              Q_PLUGIN_METADATA(IID CPlugin_iid)
          #endif

        • 在构造函数中初始化操作。例如：初始化资源等

           
              //rfb::SecurityClient::setDefaults();
           

        • 在析构函数中释放资源。
        • 实现属性、函数
          • 插件名：必须与工程名（翻译资源文件名[.ts]）相同。

            // Author: Kang Lin <kl222@126.com>
             
            #include "PluginRabbitVNC.h"
             
            #include "RabbitCommonDir.h"
            #include "../../TigerVnc/Client/ConnecterVnc.h"
             
            #include <QLoggingCategory>
             
            Q_LOGGING_CATEGORY(log, "RabbitVNC")
             
            CPluginRabbitVNC::CPluginRabbitVNC(QObject *parent)
                : CPluginClient(parent)
            {
             
                //rfb::SecurityClient::setDefaults();
             
            }
             
            CPluginRabbitVNC::~CPluginRabbitVNC()
            {
                qDebug(log) << "CPluginRabbitVnc::~CPluginRabbitVnc()";
            }
             
            const CPluginRabbitVNC::TYPE CPluginRabbitVNC::Type() const
            {
                return TYPE::RemoteDesktop;
            }
             
            const QString CPluginRabbitVNC::Name() const
            {
                return "RabbitVNC";
            }
             
            const QString CPluginRabbitVNC::DisplayName() const
            {
                return tr("RabbitVNC");
            }
             
            const QString CPluginRabbitVNC::Description() const
            {
                return tr("VNC(Virtual Network Console): Access remote desktops such as unix/linux, windows, etc.") + "\n"
                       + tr("VNC is a set of programs using the RFB (Remote Frame Buffer) protocol.") + "\n"
                       + tr("The plugin is used RabbitVNC");
            }
             
            const QString CPluginRabbitVNC::Protocol() const
            {
                return "RFB";
            }
             
            const QIcon CPluginRabbitVNC::Icon() const
            {
                return QIcon::fromTheme("network-wired");
            }
             
            const QString CPluginRabbitVNC::Version() const
            {
                return PluginRabbitVNC_VERSION;
            }
             
            COperate *CPluginRabbitVNC::OnCreateOperate(const QString &szID)
            {
                if(Id() == szID)
                {
                    return new CConnecterVnc(this);
                }
                return nullptr;
            }

  • 实现连接者接口 COperate 。
    • 实现远程桌面
      • 如果是阻塞线程模型。实现一个后台线程处理一个远程连接，连接是阻塞的。 可以从 COperateThread 派生。例如：COperateFreeRDP
      • 如果没有后台线程，或者是非阻塞线程模型(实现一个后台线程处理多个远程连接，连接是非阻塞的)。 可以从 COperateDesktop 派生。
    • 实现远程控制台，可以从 COperateTerminal 派生
    • 如果上面两个不能满足你的需要，你可以直接从 COperate 派生
  • 实现具体的连接，从 CConnect 派生 。例如：CConnectFreeRDP