WebSocket++ 环境搭建

一、类库简介

WebSocket++ 只是一个头库,它实现了RFC6455的 WebSocket 协议。可用于编写基于 C++ 语言的客户端应用程序和服务器端应用程序。
该库依赖 Asio 库,可包含 boost 中的 asio 库或包含独立的 asio 库。

主要特性

  • 完全支持 RFC6455
  • 部分支持 Hixie 76 / Hybi 00
  • 基于消息、事件的接口
  • 支持安全的 WebSockets(TLS),IP6 和 explicit proxies
  • 灵活的依赖管理(C++11 标准库或 Boost)
  • 可移植、跨平台(Posix/Windows,32/64位,Intel/ARM/PPC)

二、类库下载

WebSocket++ 下载地址
https://github.com/zaphoyd/we...

Boost 1.69.0 下载(与Asio二选一)
https://www.boost.org/users/h...

Asio 独立库(与Boost二选一)
http://www.think-async.com

三、编译工程

个人感觉其实也可以不编译整个工程,编译工程主要是为了演示工程的完整性。如果只是关注搭建自己的开发环境,可跳过此章节直接参考 “创建自定义工程”。

3.1 准备编译环境

# 安装工程构建工具和C++编译器
$ sudo apt install cmake scons g++ -y

# 安装openssl开发库
$ sudo apt install libssl-dev

# 编译boost库
$ ./bootstrap.sh
$ ./b2

3.2 方式一:通过 cmake 编译

# 导出环境变量(boost路径根据自己情况设置)
$ export BOOST_ROOT="/home/sprite/Library/boost_1_69_0"

# 通过 cmake 编译所有工程(位于WebSocketpp主目录)
$ mkdir build && cd build
$ cmake -DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON ..
$ make

3.3 方式二:通过 scons 编译

# 导出环境变量(boost路径根据自己情况设置)
$ export BOOST_ROOT="/home/sprite/Library/boost_1_69_0"

# 通过 scons 编译所有工程(位于WebSocketpp主目录)
$ scons

3.4 编译说明

  • 工程支持 cmake 式和 scons 两种构建方式,可任选一种。
  • 无论基于 cmake 还是 scons 构建,均基于 Boost 库构建,需通过 BOOST_ROOT 环境变量指定 Boost 库路径。
  • 工程内的 examples、test、tutorials 子工程不可以单独编译,因为工程的构建体系是按整体构建设计的。
  • 创建自己工程时可直接使用独立的 asio 库,而不依赖 boost 库,也无需指定 BOOST_ROOT 环境变量。

四、创建自定义工程

关于 CMake 的工程组织及构建方法这里不再赘述,请参考本人之前的 CMake 系列文章。

本示例工程只有两个文件(CMakeLists.txt、server.cpp),实现了最简单的服务器端信息回显功能。开发人员可通过 http://www.websocket-test.com/ 网站填写自己主机服务器的 URI 进行测试。

4.1 工程文件

  • CMakeLists.txt

    # 所需 cmake 的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(server)
    
    # 启用 C++11
    add_definitions(-std=c++11)
    
    # 使用独立 Asio
    add_definitions(-DASIO_STANDALONE)
    
    # Asio 库根目录
    set(ASIO_ROOT "/home/sprite/Library/asio_1.12.2")
    
    # WebSocket++ 头文件目录
    set(WEBSOCKET_INCLUDE "/home/sprite/websocket/websocketpp-master")
    
    # 生成可执行程序
    add_executable(${PROJECT_NAME} server.cpp)
    
    # 头文件搜索路径
    target_include_directories(${PROJECT_NAME} PUBLIC 
        ${ASIO_ROOT}/include
        ${WEBSOCKET_INCLUDE}
    )
    
    # 链接库文件(安全连接需链接 ssl crypto)
    target_link_libraries(${PROJECT_NAME} pthread)
  • server.cpp

    #include <websocketpp/config/asio_no_tls.hpp>
    #include <websocketpp/server.hpp>
    #include <functional>
    
    typedef websocketpp::server<websocketpp::config::asio> server;
    
    class utility_server {
    public:
        utility_server() {
             // Set logging settings
            m_endpoint.set_error_channels(websocketpp::log::elevel::all);
            m_endpoint.set_access_channels(websocketpp::log::alevel::all ^ websocketpp::log::alevel::frame_payload);
    
            // Initialize Asio
            m_endpoint.init_asio();
    
            // Set the default message handler to the echo handler
            m_endpoint.set_message_handler(std::bind(
                &utility_server::echo_handler, this,
                std::placeholders::_1, std::placeholders::_2
            ));
        }
    
        void echo_handler(websocketpp::connection_hdl hdl, server::message_ptr msg) {
            // write a new message
            m_endpoint.send(hdl, msg->get_payload(), msg->get_opcode());
        }
    
        void run() {
            // Listen on port 9002
            m_endpoint.listen(9002);
    
            // Queues a connection accept operation
            m_endpoint.start_accept();
    
            // Start the Asio io_service run loop
            m_endpoint.run();
        }
    private:
        server m_endpoint;
    };
    
    int main() {
        utility_server s;
        s.run();
        return 0;
    }

4.2 编译运行

  • 编译

    $ mkdir build
    $ cd build
    $ cmake ..
    $ make
  • 运行

    ./server

4.3 运行效果

  • 页面修改URI

    # 浏览器访问页面
    http://www.websocket-test.com/
    
    # 连接前的文本框输入自己server程序所在主机ip地址
    ws://192.168.88.128:9002
    
    # 单击 “断开” 按钮,然后再单击 “连接”按钮
    “发送的文本” 输入内容并点击 “发送(ctrl+回车)” 按钮发送数据
  • 运行效果图
    clipboard.png

五、参考链接

评论

暂无评论