讓模組接收自己的指令
上一篇已經用過 sender send。這篇沿用同一個計數範例,讓 receiver 接收兩個指令:status 查看接收數量,reset 將數量歸零。
1. 建置並啟動範例
Section titled “1. 建置並啟動範例”若前一次的 Vinc Shell 還開著,先輸入 exit。回到 open-vinc-examples 專案根目錄重新建置:
cmake --build build/debugcmake --build build/python在 PowerShell 開啟 Vinc Shell:
.\build\debug\Vinc.exe.\build\python\Vinc.exe --python .\.venv\Scripts\python.exe接下來的指令都輸入在 Vinc Shell。先啟動接收端:
counterSubscriber等到 ready receiver 與 Started receiver 出現,再啟動發送端:
counterPublisher等到 ready sender 與 Started sender 出現,就可以開始操作。若需要前面的建置步驟,請看第一個跨程序訊息。
2. 用 status 查看數量
Section titled “2. 用 status 查看數量”先送一筆訊息:
sender send等到接收端印出:
received sequence=1 publisher=sender再查詢數量:
receiver status輸出會包含:
received=1這個指令裡,receiver 指定要操作的 Module,status 是交給它處理的指令。
3. 用 reset 將數量歸零
Section titled “3. 用 reset 將數量歸零”輸入新指令:
receiver reset等到看到:
counter reset再輸入:
receiver status這次會看到:
received=0reset 只清除 receiver 記錄的接收數量,沒有改動 sender 的訊息序號。之後再送訊息,接收數量會重新累積。
4. 試試不支援的指令
Section titled “4. 試試不支援的指令”輸入:
receiver unknown輸出會包含用法提示:
Usage: receiver [status|reset]receiver returned 1這表示本例接受 status 或 reset。指令失敗後,Module 仍然運行;再輸入 receiver status,仍能查到 received=0。
5. 指令如何進到程式裡
Section titled “5. 指令如何進到程式裡”實作放在 modules/subscriber.cpp 的 module_interface()。先只看這個函式:
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。函式先移除開頭的實例名稱,剩下的就是要處理的指令。
def module_interface(self, args): # 指令 hook:Shell 將指令送到這個實例時,由框架呼叫。 # 回傳 0 表示成功,回傳 1 表示指令執行失敗。 # args 只包含指令參數,實例名稱已經移除。 if not args: args = ["status"]
if args == ["status"]: print(f"received={self.received}") return 0
if args == ["reset"]: self.received = 0 print("counter reset") return 0
print("Usage: receiver [status|reset]") return 1python/modules/counterSubscriber/counterSubscriber.py · e165aed · 中文註解
實作放在 python/modules/counterSubscriber/counterSubscriber.py。以 receiver status 為例,Python 的 args 已經移除實例名稱,收到的是 ["status"],可以直接比對。
例如 receiver reset extra 會收到 ["reset", "extra"],與 ["reset"] 不同,因此會被判定為用法不符。
接著依序判斷:
- 沒有子指令時,預設使用
status。 - 收到
status,印出目前的接收數量。 - 收到
reset,先把接收數量設為0,再印出完成訊息。 - 其他指令或多餘參數,印出用法提示。
本例用 return 0 表示這次指令成功,return 1 表示用法不符。回傳的是這次指令的結果,不是要求 Module 關閉。
6. 正常關閉
Section titled “6. 正常關閉”完成後輸入:
exit兩個 Module 正常停止後,會回到 PowerShell。
你現在可以沿用同樣的判斷方式,在 module_interface() 加入自己的指令。接著閱讀設定與儲存模組參數,調整計數步進,並在重啟後沿用設定。