Websocket

[gliechtenstein]

Actions:

• There are 3 actions: Open, Close, Send
• All actions are asynchronous => They don't wait for a response and immediately calls "success"
• Instead of a return value, all of these actions trigger a service.
• The corresponding service (can be seen at JasonWebsocketService) emits an event when there's a result.

[1] $websocket.open

{
    "type": "$websocket.open",
    "options": {
        "url": "..."
    },
    "success": { ... }
}

[2] $websocket.close

{
    "type": "$websocket.close",
    "success": { ... }
}

[3] $websocket.send

{
    "type": "$websocket.send",
    "options": {
        "message": "..."
    },
    "success": { ... }
}

Events:

• There are 4 events: $websocket.onopen, $websocket.onclose, $websocket.onmessage, $websocket.onerror

[1] $websocket.onopen

• Triggered when $websocket.open action succeeds.
• You can start sending messages after this event.
• Response Payload: none

[2] $websocket.onclose

• Triggered when $websocket.close action succeeds or the socket closes
• Response Payload: none

[3] $websocket.onerror

• Triggered when there's an error
• Response Payload:

{
  "$jason": {
    "error": [THE ERROR MESSAGE]
  }
}

[4] $websocket.onmessage

• Triggered whenever there's an incoming message
• Response Payload:

{
  "$jason": {
    "message": [THE INCOMING MESSAGE STRING]
  }
}