@dir:/connectivity;

WebSocket Events Lib - Connectivity
As we fully support Open Source and the ability of those using the plugin to create their own library,
so this documentation will help you move through our protocols to establish a secure connection via WebSocket.

Complex and Simple connections
Our WebSockets distinguish between two different types of connectivity, depending on what the library you use offers:

Complex connection
Complex connections are the connections usually initialized by the WebSocket class of JavaScript and feature complex header sending and message encoding.
It is the default type, so it should not be defined in the headers.

Simple connection
Simple connections, on the other hand, represent the sending and receiving of a simple message that is not complex (but of variable length)
and skips the process of "decoding" and "encoding" the messages themselves.
To use this type, it is necessary to define it in the headers:

Connection headers
It is preferable, even for the purpose of authentication, to send headers to connect to the WebSocket server:

Authentication
Authentication is a key step in connecting to the WebSocket: the latter will calculate permissions based on the configuration of the plugin.
There are three different types of authentication that are equally important, although the third can be disabled from the configuration.

1 | Basic URL-Auth
Available only in WebSocket version 13 allows the token NOT IN base64 to be passed directly into the connection URI:

2 | Headers Auth
Always available, it is simply a matter of including in the headers also one dedicated to authentication with the IN base64 token:

3 | DoubleRequest-Auth
This authentication mode is the most complicated and sensitive, so it can be disabled from the plugin settings.
Here is an explanation of how the connection should be made:



Heartbeat
Various functions can be performed to keep the connection alive, simply by sending a message:

Simple Heartbeat
An ordinary heartbeat, can be triggered by sending one of the following messages:
There will be a simple plain-text negligible answer

Heartbeat + Server Chunk
While keeping the connection alive you can as well receive the information about the server (in a JSON) using the following message:
The entire server object (to be imported into the respective class) will be received


Fetch a Player
Being able to retrieve real-time information about a player is one of the most useful and basic functions of this system.
Though the player is passed directly with each event where one of the subjects it is possible to retrieve externally to the events all the complete information about a player by sending the following JSON request to the WebSocket Server:
Note: You must set the cached arg to false!

The response will be a simple JSON with "status" (200 if successful) and the player information in "data"

WARNING
In case the permissions for the token used by the client regarding players is not on `*` then only the permitted values (given in the plugin config) will be included in the response!

WARNING
To avoid any possible error, the server will wait exactly 1 second before sending the response


Fetch the Server
It is possible to retrieve information about the server using the following JSON:

The response will be a simple JSON with "status" (200 if successful) and the server informations in "data"

WARNING
In case the permissions for the token used by the client regarding server is not on `*` then only the permitted values (given in the plugin config) will be included in the response!


Execute an action
Another important element of the plugin is the ability to execute simple direct commands to the player or console.

Player
Performing actions for a player is easy.
In fact, it will be enough to provide the player's username and, of course, the function to be performed.
Note: All executable functions are in effect the function names of the Player class!

Server
Performing actions for the console is easy.
In fact, it will be enough to provide the command to be performed.


Receive Events
Events are the main part of this plugin and therefore are both easy to manage and protected by the plugin configuration.
In fact, for each token it is possible to define what events are transmitted.

Base structure
It's a simple JSON:
(This example is for the player_join event)