Blog

如果要使用 WebSocket 的話，基本上就是先到 GitHub 上 0.3.x 這個分支：

https://github.com/zaphoyd/websocketpp/tree/experimental

去把檔案下載下來。

而下載下來的檔案裡面，「websocketpp」這個資料夾，就是要使用這個函式庫時，所有需要的檔案了～而文件的部分，則是要連到他的網頁（連結）去看，內容不算很完整，Heresy 算是看著範例程式和原始碼寫出來的；這點算是 Heresy 覺得這個函式庫做的比較差一點的地方，不過考慮到現在還是 0.3 版，也就不要要求太多了。

另外，由於他是基於 Boost ASIO 來開發網路的功能，所以也必須要下載 Boost C Libraries 來使用；Boost 的官方網站是：http://www.boost.org/。

而如果有需要用到 TLS 的加密連線的話，應該是會需要使用 OpenSSL 這個函式庫（官網）；如果不打算做加密連線的話，基本上是可以跳過這個函式庫的。（Heresy 沒試過這部分）

WebSocket 的基本使用說明，可以參考《Building a program with WebSocket 》這份文件。Heresy 這邊算是整理一下，自己玩過後的想法。

首先，要使用 WebSocket 來開發程式的時候，基本上要 include 兩種檔案，一種是用來做組態設定（config）的，一種則是用來決定要開發的程式的腳色類型（Role）的。

Role

#include <websocketpp/server.hpp>

#include <websocketpp/client.hpp>

Config

#include <websocketpp/config/asio_no_tls.hpp>

Endpoint

#include <websocketpp/server.hpp>
#include <websocketpp/config/asio_no_tls.hpp>

websocketpp::server<websocketpp::config::asio> mServer;

基本上，因為 Heresy 的目的是要建立一個 WebSocket Server 讓網頁來連線，所以這邊就只講 Server 的部分了～而實際上，在《Building a program with WebSocket 》裡，官方就有提供一個很簡單的使用範例了～他的程式碼如下：

#include <iostream>
  
#include <websocketpp/config/asio_no_tls.hpp>
#include <websocketpp/server.hpp>
  
typedef websocketpp::server<websocketpp::config::asio> server;
  
void on_message(websocketpp::connection_hdl hdl, server::message_ptr msg)
{
  std::cout << msg->get_payload() << std::endl;
}
  
int main()
{
  server print_server;
  
  print_server.set_message_handler(&on_message);
  
  print_server.init_asio();
  print_server.listen(9002);
  print_server.start_accept();
  
  print_server.run();
}

在這個範例裡面，他是透過 websocketpp::server<websocketpp::config::asio> 這個 Endpoint，來建立一個使用 Boost ASIO、沒有 TLS 加密的 WebSocket Server。這個 server 程式在執行後，會持續去監聽 port 9002，當有訊息傳遞進來的時候，就會觸發到 on_message() 這個函式、並把接到的訊息輸出到命令提示字元的視窗上。

如果想要測試連線的話，可以考慮用 WebSocket.org 提供的 Echo Test 這個網頁來做測試；要連線到本機的 server 的話，只要在「location」輸入「ws://localhost:9002」後、按「connect」就可以連上。而連上後，在下方的「Message」裡面、輸入訊息後按下「Send」按鈕，應該就可以看到 Server 端的命令提示字元的視窗裡，會出現在網頁上打的文字了～

不過實際上，由於 WebSocket 本身也有 log 的功能，所以除了收到的訊息會被輸出之外，還有很多紀錄用的訊息，也都會被輸出在畫面上，看起來可能會有點雜亂就是了。

另外，由於這個範例程式，只會從 client 接收訊息，並不會傳送資料給 Server 端，所以 Echo Text 的 Log 裡面，並不會像連到 ws://echo.websocket.org 一樣，送出訊息後，還會有回應。

在程式碼的地方，首先就是建立出一個 endpoint 的 server 物件 print_server，用來做後續的操作。

而在建立出 print_server 後，接下來要做的事情，包括了：

那要怎麼處理連線進來的訊息呢？WebSocket 是透過提供各種「Handler」（callback function），來做事件的處理；在官方網站上，有列出可以使用的 handler 列表（頁面）。

而在這個範例裡，則是透過 set_message_handler()，來設定當 Server 收到訊息時，要執行的 callback function，這裡就是 on_message() 這個函式；這也是一般來說，一定會用到的 callback function。

而 message handler 的 callback function，會收到兩個資料：

一個是 websocketpp::connection_hdl 型別的資料，是用來識別目前的連線用的；如果之後要傳送訊息給 client 的話，就必須要透過這個物件，來設定要把訊息傳送給誰。而如果有需要的話，也可以藉由 server<> 的 get_con_fromhdl() 來取得觸發這個事件的連線、以及他的資訊。

第二個資訊，則是 websocketpp::server<>::message_ptr，裡面儲存的是傳遞進來的訊息。一般來說，這會透過他的 get_payload() 函式，來取得傳遞進來的訊息，而得到的資料，會是 const string&。不過由於 WebSocket 也有可能是傳遞非文字的 binary 資料，所以可能會需要透過  get_opcode() 這個函式，來辨別傳遞進來的資料的形式。

而在這個範例裡面，on_message() 這個函式，就是很單純地把街道的資訊，透過 iostream 做輸出了～

在網頁上的這個範例裡面，這個 Server 只有做接收的功能，並不會送訊息給 Client 端。那如果要送訊息給 client 端要怎麼做呢？基本上就是呼叫 server<> 的 send() 這個函式就可以了。

在官方的 example 資料夾裡，有個 echo_server 的目錄，裡面的 echo_server.cpp，就是一個更完整一點，在接到訊息後，會把訊息原封不動地回傳給 client 端的範例程式。

而他送出資料的方法，就是：

s->send(hdl, msg->get_payload(), msg->get_opcode());

這邊可以看到，要呼叫 sned() 這個函式來傳遞資料，基本上是需要給他三個參數：

而這個範例程式在執行後，如果一樣使用 WebSocket.org 的 Echo Test 來測試的話，就可以發現他的功能和 WebSocket.org 測試用的 ws://echo.websocket.org 一樣了～

上面基本上就是 WebSocket 使用上的基本用法。不過實際上，這樣的程式碼，在 Heresy 這邊的 Windows Visual Studio 2010 / 2012，都是沒辦法正確建置的。

最主要的問題，基本上應該算是 VC 本身對 Boost C Library 的支援性問題吧…在 Heresy 測試的結果是發現，如果希望在 VisualStudio 2010 或 2012 上使用的 WebSocket 的話，有部分的功能必須要強制讓 WebSocket 去使用 C 11 的內建函式庫，而不要去使用 Boost 的版本。

設定的方法，可以參考官方的《C 11 Support》這頁。以 Heresy 這邊的測試來說，至少 functional 和 memory 兩個函式庫，是需要使用 C 11 STL 的版本才行的；也就是說，必須要加上 _WEBSOCKETPP_CPP11_MEMORY_ 和 _WEBSOCKETPP_CPP11_FUNCTIONAL_ 這兩個定義（因為 MSVC 不支援完整的 C 11，所以不能直接用 _WEBSOCKETPP_CPP11_STL_）。

但是，在加上這兩個定義後，實際上會產生另一個問題，那就是 std::min() 和巨集版本的 min() 衝到的問題（參考）；這個問題，比較簡單的方法，就是在再額外定義一個 NOMINMAX，來取消掉巨集版本的 min() 和 max() 了。

所以，實際上要讓上面的程式可以正常運作，一個方法就是在原始碼的一開始、include WebSocket 的 Header 之前，先加上下面三行：

#define NOMINMAX
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_MEMORY_ 

或是在 VC 的專案屬性的「組態屬性」裡面，找到「C/C 」的「前置處理器」，在「前置處理氣定義」的欄位裡面，加上「NOMINMAX;_WEBSOCKETPP_CPP11_FUNCTIONAL_;_WEBSOCKETPP_CPP11_MEMORY_ 」了。

理論上，這兩種方法應該都可以讓 MSVC 可以正確地建置上面的範例程式。而這個問題 Heresy 也有回報給作者了（連結），就看之後有沒有辦法修正吧。

另外，Heresy 在使用 Visual Studio 2012 的時候，雖然可以正確編譯了，可是在執行階段，則是會當掉。稍微追了一下程式碼後，發現應該是 Visual Studio 2012 的 std::strftime() 這個函式（MSDN）有問題所造成的。

主要的問題是發生在  logger/basic.hpp 這個檔案，裡面定義的 get_timestamp() 這個函式裡面有透過 std::strftime() 來列印出目前的時間，以做為紀錄之用；而他定義的輸出字串，則是一個長度 30 的 C 字串 buffer。

由於他有試著輸出時區的資訊（%z），而在 Visual Sutdio 裡，如果在台灣的環境的話，他會是一個「台北標準時間」這樣的文字；而這樣的文字，再加上前面的時間資訊的會，就導致整個結果會超過 30 個字元。而在這個狀況下，Visual Studio 2010 只是會無法輸出，但是在 Visual Studio 2012，卻可能是讓程式整個當掉… orz

而解決方法呢？基本上應該是兩種，一個是把 buffer 的大小改大、例如把它改成 40（要改兩個地方，一個是 105 行、一個是 111 行，參考），這樣可以讓字串夠長、不會出問題；另一種方法，則是把 105 行裡定義的時間格式字串「"%Y-%m-%d %H:%M:%S%z"」，最後面的「%z」拿掉，這樣就不會去處理時區的資訊，也就比較不容易出問題了。

而這個問題，也已經回報給 WebSocket 的作者了（連結）（MS 那邊姑且也回報了，會不會受理就不曉得了）。