跳到內容

讓模組接收自己的指令

文件對應版本v0.2.0/main 穩定版

上一篇已經用過 sender send。這篇沿用同一個計數範例,讓 receiver 接收兩個指令:status 查看接收數量,reset 將數量歸零。

若前一次的 Vinc Shell 還開著,先輸入 exit。回到 open-vinc-examples 專案根目錄重新建置:

終端機視窗
cmake --build build/debug

在 PowerShell 開啟 Vinc Shell:

終端機視窗
.\build\debug\Vinc.exe

接下來的指令都輸入在 Vinc Shell。先啟動接收端:

counterSubscriber

等到 ready receiver 與 Started receiver 出現,再啟動發送端:

counterPublisher

等到 ready sender 與 Started sender 出現,就可以開始操作。若需要前面的建置步驟,請看第一個跨程序訊息。

先送一筆訊息:

sender send

等到接收端印出:

received sequence=1 publisher=sender

再查詢數量:

receiver status

輸出會包含:

received=1

這個指令裡,receiver 指定要操作的 Module,status 是交給它處理的指令。

輸入新指令:

receiver reset

等到看到:

counter reset

再輸入:

receiver status

這次會看到:

received=0

reset 只清除 receiver 記錄的接收數量,沒有改動 sender 的訊息序號。之後再送訊息,接收數量會重新累積。

輸入:

receiver unknown

輸出會包含用法提示:

Usage: receiver [status|reset]
receiver returned 1

這表示本例接受 status 或 reset。指令失敗後,Module 仍然運行;再輸入 receiver status,仍能查到 received=0。

實作放在 modules/subscriber.cpp 的 module_interface()。先只看這個函式:

modules/subscriber.cpp
vinc::Result<std::int32_t> module_interface(std::vector<std::string> args) override {
// 指令 hook:Shell 將指令送到這個實例時,由框架呼叫。
// 回傳 0 表示成功,回傳 1 表示指令執行失敗。
if (!args.empty() && args.front() == get_module_name()) {
args.erase(args.begin());
}
if (args.empty()) {
args.push_back("status");
}
if (args.size() == 1 && args.front() == "status") {
std::cout << "received=" << received_ << std::endl;
return 0;
}
if (args.size() == 1 && args.front() == "reset") {
received_ = 0;
std::cout << "counter reset" << std::endl;
return 0;
}
std::cout << "Usage: receiver [status|reset]" << std::endl;
return 1;
}

modules/subscriber.cpp · e165aed · 中文註解

以 receiver status 為例,Shell 傳進來的 args 依序是 receiver、status。函式先移除開頭的實例名稱,剩下的就是要處理的指令。

接著依序判斷:

  • 沒有子指令時,預設使用 status。
  • 收到 status,印出目前的接收數量。
  • 收到 reset,先把接收數量設為 0,再印出完成訊息。
  • 其他指令或多餘參數,印出用法提示。

本例用 return 0 表示這次指令成功,return 1 表示用法不符。回傳的是這次指令的結果,不是要求 Module 關閉。

完成後輸入:

exit

兩個 Module 正常停止後,會回到 PowerShell。

你現在可以沿用同樣的判斷方式,在 module_interface() 加入自己的指令。接著閱讀設定與儲存模組參數,調整計數步進,並在重啟後沿用設定。