客户端插件接口

客户端插件接口. 更多...

类
class	CConnect
	连接接口。它由协议插件实现。 它默认启动一个定时器来开启一个非 Qt 事件循环（就是普通的循环处理）。 详见： Connect()、 slotTimeOut()、 OnProcess() 。 当然，它仍然支持 Qt 事件（QObject 的 信号 － 槽 机制）。 更多...
class	CConnectDesktop
	远程桌面连接接口。它由协议插件实现。 更多...
class	CConnecter
	连接者应用接口。 更多...
class	CConnecterConnect
	插件的连接者接口，此接口仅由插件使用。 所有的需要 CConnect 的插件连接者均需要从此接口派生。 更多...
class	CConnecterThread
	默认启动一个后台线程。实现一个后台线程处理一个连接。 可与插件接口从 CPluginClient 派生的插件一起使用，用于连接是阻塞模型的。 更多...
class	CFrmScroll
	The scroll form class 更多...
class	CFrmViewer
	用于显示从 CConnectDesktop 输出的图像，和向 CConnectDesktop 发送键盘、鼠标事件。 更多...
class	CParameter
	参数接口 更多...
class	CParameterUI
	参数界面接口 更多...
class	CPluginClient
	客户端插件接口。用于建立 CConnecter 实例，它由协议插件实现。 更多...

详细描述

客户端插件接口.

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

    参见

    CPluginClient CConnecterThread

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

      参见

      CPluginClientThread CConnecterDesktop

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

    # Author: Kang Lin <kl222@126.com>
     
    project(FreeRDP
        DESCRIPTION "FreeRDP client plugin"
        )
     
    SET(FreeRDP_LIBS freerdp-client freerdp winpr Client)
     
    SET(FreeRDP_SOURCE_FILES
        ParameterFreeRDP.cpp
        PluginFreeRDP.cpp
        ConnectFreeRDP.cpp
        ConnecterFreeRDP.cpp
        DlgSetFreeRDP.cpp
        ConvertKeyCode.cpp
        CursorFreeRDP.cpp
        ClipboardFreeRDP.cpp
        ClipboardMimeData.cpp
        DlgGetUserPasswordFreeRDP.cpp
        DlgDesktopSize.cpp
        )
     
    SET(FreeRDP_HEADER_FILES
        ParameterFreeRDP.h
        PluginFreeRDP.h
        ConnectFreeRDP.h
        ConnecterFreeRDP.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
        )
     
    SET(FreeRDP_DEFINITIONS
        FreeRDP_VERSION_MAJOR=${FreeRDP_MAJOR}
        FreeRDP_VERSION_MINOR=${FreeRDP_MINOR})
     
    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 plugins/Client
        OUTPUT_DIR ${CMAKE_BINARY_DIR}/plugins/Client
        INSTALL_RPATH ${INSTALL_RPATH}
        VERSION ${RabbitRemoteControl_VERSION}
        )
     

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

              Q_INTERFACES(CPluginClient)
           
          #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
              Q_PLUGIN_METADATA(IID CPluginClient_iid)
          #endif

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

            // Author: Kang Lin <kl222@126.com>
             
            #include "PluginFreeRDP.h"
            #include "ConnecterFreeRDP.h"
            #include "winpr/wlog.h"
             
            #include <QLoggingCategory>
             
            #ifdef HAVE_LIBSSH
                #include "ChannelSSHTunnel.h"
            #endif
             
            static Q_LOGGING_CATEGORY(log, "FreeRDP.Plugin")
            static Q_LOGGING_CATEGORY(LoggerFreeRDP, "FreeRDP.Log")
             
            CPluginFreeRDP::CPluginFreeRDP(QObject *parent)
                : CPluginClient(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:
                            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:
                            qFatal(msg->FormatString, 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 QString CPluginFreeRDP::Name() const
            {
                return "FreeRDP";
            }
             
            const QString CPluginFreeRDP::DisplayName() const
            {
                return tr("Free remote desktop");
            }
             
            const QString CPluginFreeRDP::Description() const
            {
                return tr("RDP(Windows remote desktop Protocol): Access remote desktops such as windows.");
            }
             
            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
                QSharedPointer<CParameterChannelSSH> parameter(new CParameterChannelSSH());
                CChannelSSHTunnel channel(parameter);
                szDetails += channel.GetDetails();
            #endif
             
                return szDetails;
            }
             
            CConnecter* CPluginFreeRDP::CreateConnecter(const QString &szId)
            {
                if(Id() == szId)
                {   
                    return new CConnecterFreeRDP(this);
                }
                return nullptr;
            }

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

              Q_INTERFACES(CPluginClient)
           
          #if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
              Q_PLUGIN_METADATA(IID CPluginClient_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 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;
            }
             
            CConnecter *CPluginRabbitVNC::CreateConnecter(const QString &szID)
            {
                if(Id() == szID)
                {
                    return new CConnecterVnc(this);
                }
                return nullptr;
            }

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