TARS WebSocket

1. 設定與連線

  TARS 中包含 WebSocket 通訊服務，如需要使用 WebSocket 服務請先點選 [參數設定] - [WebSocket服務]，確認 WebSocket 訊息服務 已勾選，模組檔名中設定 WebSocket 服務路徑。

  按照上述設定完成後，假設TARS監聽的HTTP服務埠為 8809，則使用的WebSocket路徑的格式如下：

ws://localhost:8809/message

2. 運用

  使用WebSocket 客戶端連線至 TARS 的服務端后，可使用以下方法來運行相關操作：

2.1. 註冊會話

  連線至WebSocket伺服器后，需註冊會話才可使用 TARS 的WebSocket 通訊功能。註冊會話的格式如下：

{"action":"login","sid":"test"}

  向WebSocket伺服器發送上述指令后，客戶端會話註冊完成，使用的WS會話ID為 test。

2.2. 發送字串訊息

  向其它連線的客戶端發送字串訊息，使用以下格式進行發送。

{"action":"msg","sid":"{SID}","text":"{TEXT}"}

{SID} 為目標客戶端的註冊會話ID，{TEXT} 為發送的文字資訊。

2.3. 執行資料庫查詢(SQL)

  在 TARS 中設定了資料庫連線與預設 SQL 后，可利用 TARS 來執行 SQL 查詢。發送的格式內容如下：

直接發送 SQL 語句：在 WebSocket 訊息中可直接發送 SQL 語句來執行查詢。示例如下(包含參數用法)：

{
  "action": "execsql",
  "db_name": "demo",
  "sql": "Insert Into Table_Test(FCode,FName) values(:F1,:F2)",
  "params": [
    {
      "name": "F1",
      "value": "003"
    },
    {
      "name": "F2",
      "value": "f37"
    }
  ]
}

使用預設 SQL 執行查詢：如在預設 SQL 管理中設定了查詢資訊，可發送需查詢的預設 SQL 來執行查詢。建立一個名稱為 SQLTEST 的預設 SQL，查詢語句示例如下(包含參數用法)：

Insert Into Table_Test(FCode,FName) values(:F1,:F2)

  呼叫 WebSocket 執行資料庫查詢的文字示例如下，其中的 db_name 需指定預設SQL 所在的資料庫名稱，預設為 tars。

 {
  "action": "execsql",
  "db_name": "tars",
  "sql_command_id": "SQLTEST",
  "params": [
    {
      "name": "F1",
      "value": "043"
    },
    {
      "name": "F2",
      "value": "d23"
    }
  ]
}