Class: SendByWebSocket

SendByWebSocket

Common web socket used communication with external modules.

new SendByWebSocket(wsUrl)

Parameters:
Name Type Description
wsUrl string The string of web socket URL.
Source:
sender/sendGroup/SendByWebSocket.js

Methods


createWebSocket()

Create a web socket object.
Source:
sender/sendGroup/SendByWebSocket.js

initEventHandle()

Init the event for re-connect web socket.
Source:
sender/sendGroup/SendByWebSocket.js

heartCheck()

Using ping-pong to check heart beating.
Source:
sender/sendGroup/SendByWebSocket.js

reconnect()

reconnect web socket when connection is broken.
Source:
sender/sendGroup/SendByWebSocket.js

close()

close web socket from sdk.
Source:
sender/sendGroup/SendByWebSocket.js

send(data)

Send data to server end.
Parameters:
Name Type Description
data Object The data is instance of class MessageTemplate
Source:
sender/sendGroup/SendByWebSocket.js

getMessage(message)

Parameters:
Name Type Description
message Object message response from API server.
Source:
sender/sendGroup/SendByWebSocket.js

sendMessage(args)

Parameters:
Name Type Argument Description
args Array <repeatable>
The arguments for build message sent to API server.
Source:
sender/sendGroup/SendByWebSocket.js

createMessage(args)

Build message sent to API server
Parameters:
Name Type Argument Description
args Array <repeatable>
The arguments for build message sent to API server.
Source:
sender/sendGroup/SendByWebSocket.js
Returns:
- Instance of MessageTemplate.
Type
*

hasMessage(methodName)

Check the message is in the dic. or NOT
Parameters:
Name Type Description
methodName
Source:
sender/sendGroup/SendByWebSocket.js
Returns:
Type
*