這篇文章主要介紹了微信小程式網路API Websocket詳細說明的相關資料,需要的朋友可以參考下
wx. connectSocket(OBJECT)
建立一個WebSocket 連接;一個微信小程式同時只能有一個WebSocket連接,如果目前已存在一個WebSocket連接,會自動關閉該連接,並重新建立一個WebSocket連線。
OBJECT參數說明:
#參數 | ##類型必填 | 說明 | |
---|---|---|---|
String | 是開發者 | 服務器介面位址,必須是HTTPS協議,且網域必須是後台配置的合法網域名稱 | |
Object | 否 | 請求的資料 | |
##Object | 否 | HTTP Header | |
#String | 否 | 預設為GET,有效值為: OPTIONS, GET, HEAD, POST, PUT, | DELETE, TRACE, CONNECT |
Function | 否 | 介面呼叫成功的 | 回呼函數|
Function | ##呼叫失敗的回呼函數complete | Function | |
介面呼叫結束的回呼函數(呼叫成功、失敗都會執行) | 範例程式碼: |
#
wx.connectSocket({ url:"test.php", data:{ x:"", y:"" }, header:{ 'content-type': 'application/json' }, method:"GET" })
tOp
en(C
BACK)監聽WebSocket連線開啟事件
##範例程式碼:wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket连接已打开!") })
wx.onSocketError(CALLBACK)
監聽WebSocket錯誤
#範例程式碼:
wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket连接已打开!") }) wx.onSocketError(function(res){ console.log("WebSocket连接打开失败,请检查!") })
wx.s
SocketMessage(OBJECT)
透過WebSocket連線傳送數據,需要先wx.connectSocket,並在wx.onSocketOpen回呼之後才能發送。 OBJECT參數說明:
參數
說明 | |||
---|---|---|---|
是 | 需要傳送的內容 |
var socketOpen = false; var socketMsgQueue = [] wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ socketOpen = true; for(var i = 0 ; i < socketMsgQueue.length; i++){ sendSocketMessage(socketMsgQueue[i]) } socketMsgQueue = []; }) function sendSocketMessage(msg){ if(socketOpen){ wx.sendSocketMessage({ data:msg }); }else{ socketMsgQueue.push(msg) } }
wx.onSocketMessage(CALLBACK)
監聽WebSocket接受到伺服器的訊息事件
CALLBACK回傳參數:
說明 | ||
---|---|---|
伺服器傳回的訊息 |
wx.connectSocket({ url:"test.php" }); wx.onSocketMessage(function(res){ console.log("收到服务器内容:" + res.data) })
wx.closeSocket()
關閉WebSocket連線
wx.onSocketClose(CALLBACK)
#監聽WebSocket關閉
wx.connectSocket({ url:"test.php" }); //注意这里有时序问题, //如果wx.connectSocket还没回调wx.onSocketOpen,而先调用wx.closeSocket,那么就做不到关闭WebSocket的目的 //必须在WebSocket打开期间调用wx.closeSocket才能关闭 wx.onSocketOpen(function(){ wx.closeSocket() }) wx.onSocketClose(function(res){ console.log("WebSocket 已关闭!") })
感謝閱讀,希望能幫助大家,謝謝大家對本站的支持!
以上是微信小程式網路API Websocket詳細說明的詳細內容。更多資訊請關注PHP中文網其他相關文章!