websocket-api

WebSocket server

WebSocket server for a lobby that implements the protocol and functionality described under Websockets API.

API

Authentication

Client sends

    {
        "$type": "login",
        "username": "user1234",
        "password": "password1234"
    }

Server responds

    { "$type": "login_failed" }

    {
        "$type": "login_successful",
        "user_type": "admin"
    }

User types are admin or user.

Pinging the server

The client can ping the server to check your connectivity. Client does a ping, including the sequence number (which allows to trace the exact ping duration).
```
  {
    "$type": "ping",
    "seq": 1
  }
```
server will respond:
```
  {
    "$type": "pong",
    "seq": 1
  }
```

Subscribing to the list of tables

Client request

{ "$type": "subscribe_tables" }

Server will respond with the list of tables, and update the client with table_added, table_removed and table_updated messages whenever the status has changed.

{
  "$type": "table_list",
  "tables": [
    {
        "id": 1,
        "name": "table -James Bond",
        "participants": 7
    }, 
    {
        "id": 2,
        "name": "table -Mission Impossible",
        "participants": 4
    }
  ]
}

Unsurprising from the list of tables
```
 {"$type": "unsubscribe_tables"}
```
(No response from server is expected here)

Privileged commands

Only admins are allowed to use these commands, otherwise the server must respond with:

 { "$type": "not_authorized" }

Add table to server

Client sends:

    {
      "$type": "add_table",
      "after_id": 1,
      "table": {
        "name": "table -Foo Fighters",
        "participants": 4
      }
    }

Update table

Client sends:

{
  "$type": "update_table",
  "table": {
    "id": 3,
    "name": "table -Foo Fighters",
    "participants": 4
    }
}

Remove table

    {
      "$type": "remove_table",
      "id": 3
    }

Events

When user edits or removes a table client must do an optimistic UI update. However if server responds with failure the optimistic update should be reverted.

Possible failure event:

    {
      "$type": "removal_failed",
      "id": 3
    }

    {
      "$type": "update_failed",
      "id": 3
    }

Possible success events:

New table added

{
  "$type": "table_added",
  "after_id": 1,
  "table": {
    "id": 3,
    "name": "table -Foo Fighters",
    "participants": 9
  }
}

If after_id is -1, the table has to be added at the beginning;

Table has been closed/removed

{
  "$type": "table_removed",
  "id": 1
}

Table updated

{
  "$type": "table_updated",
  "table": {
    "id": 3,
    "name": "table -Foo Fighters",
    "participants": 9
  }
}

oleksiypr/websoket-api