Skip to content
This repository was archived by the owner on Nov 10, 2021. It is now read-only.

List of WebSocketCommander

0ddlyoko edited this page Feb 25, 2020 · 5 revisions

Here is a list of WebSocketCommander used by FroxyNetwork:

Unregistered messages: These messages will not be registered because they are used by the program (in fact they are registered but not called)

  • auth:

    • Used by: ServerManager
    • Sent by: Servers
    • Description: Register through WebSocket
    • Params: <id | bungeecord>
      • <id | bungeecord> : The id of the server or "bungeecord"
      • The clientId returns by the REST server
      • The actual token
  • connection:

    • Used by: Servers
    • Sent by: ServerManager
    • Description: Indicate server is connected and authenticated
    • Params: ok
      • ok is now the only parameter that will be sent by the ServerManager. This indicate the server is registered and authenticated
  • register:

    • Used by: ServerManager
    • Sent by: Servers
    • Description: Indicate Server want to register to a specific canal
    • Params:
      • The canal the Server want to listen
  • unregister:

    • Used by: ServerManager
    • Sent by: Servers
    • Description: Indicate Server want to unregister to a specific canal
    • Params:
      • The canal the Server want to stop listenning
  • stop:

    • Used by: Servers
    • Sent by: ServerManager
    • Description: Used by Servers and sent by ServerManager to close server with or without raison
    • Params: [message]
      • Optional, the message that will be display when the server will stops
  • WebSocketRegister:

    • Used by: FroxyBungee
    • Sent by: ServerManager
    • Description: Used when a new Server is registered, opened and loaded
    • Params: <serverId> <host> <port> <motd>
      • serverId: The id of the server
      • host: The host
      • port: The port
      • motd: The motd of the server (This param will probably be modified in the futur)
  • WebSocketUnregister:

    • Used by: FroxyBungee
    • Sent by: ServerManager
    • Description: Used when a Server is closing
    • Params:
      • serverId: The id of the server

Clone this wiki locally