Skip to content

Commit 632b191

Browse files
Update README.md
1 parent ac7e293 commit 632b191

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This rich and varied library will greatly facilitate development, it is very lig
99
* Possible to limit the number of simultaneously connected clients
1010
* Header on Message requests.
1111

12-
### Authentication module:
12+
### 🔒 Authentication module:
1313
Customers log in by presenting their username, group and token.
1414

1515
Each client's token is never stored, yet authentication works even after a server restart, how do you think it is?
@@ -20,23 +20,23 @@ but also at each connection to compare the tokens and thus authorize the connect
2020

2121
If you want to "create" accounts automatically, just use this equation wherever you want.
2222

23-
### Autorization Mode system:
23+
### 🔑 Autorization Mode system:
2424
In the server options you will have the choice between:
2525
* ALL (each client can send a Message request to all clients at once without specifying their name)
2626
* SINGLE (each customer will have to know the name of the customers to whom he wants to send, he will have to send them one by one if there are several)
2727
* NOTHING (no exchanges will be allowed, for all customers without exceptions)
2828

29-
### Open to the internet:
29+
### 😈 Open to the internet:
3030
You can easily open the server port to the internet if your use requires it,
3131
You will not have to worry about the authentication system.
3232

33-
### Response / Callback system:
33+
### 💣 Response / Callback system:
3434
When a client receives a Message request, it can return a response to that request using the request id it contains in the header (the ``reply(...)`` methods will do the job for you).
3535

3636
On the other side, from the sender, once the request has been sent, he can wait for an asynchronous response specific to this request, with a temporary single-use biconsumer event.
3737

3838

39-
### Limit
39+
### 💤 Limit
4040
You can easily limit the number of clients allowed to connect simultaneously
4141
You can also allow a number of clients with the same username (so yes, you can connect clients with the same username logged in)
4242

@@ -152,7 +152,7 @@ boolean state = server.isClosed();
152152

153153
Now, we will learn how to harness the potential of the API methods of the server:
154154

155-
### User Manager
155+
### 👻 User Manager
156156
The user manager makes it possible to recover the desired user instances and to be able to disconnect them
157157
```java
158158
final UserManager usrMan = server.getUserManager();
@@ -179,15 +179,15 @@ final Set<ClientLogged> allClients = usrMan.getAllUsers();
179179
// get all connected clients
180180
```
181181

182-
### Login manager
182+
### 👀 Login manager
183183
Allows you to generate a token from a provided Session instance
184184
```java
185185
final LoginManager loginMan = server.getLoginManager();
186186

187187
String token = loginMan.getTokenRelated(Session session);
188188
```
189189

190-
### Registering events
190+
### 🔥 Registering events
191191
Great novelty for this API: the server can now process requests in addition to redistributing them
192192

193193
#### For Action event:
@@ -277,7 +277,7 @@ server.onMessage("channel name", (event, client) -> {
277277
});
278278
});
279279
```
280-
### What to do with a ClientLogged ?
280+
### What to do with a ClientLogged ?
281281
An instance of this class represents a client session.
282282
If multiple clients are connected with the same name, they each have a dedicated instance.
283283
```java
@@ -363,7 +363,7 @@ client.close();
363363
// disconnect the client and remove, eliminate it in GC
364364

365365
```
366-
### Registering events
366+
### 🔥 Registering events
367367
The client can also listen to the requests he receives on certain channels
368368
#### For Action event:
369369
```java

0 commit comments

Comments
 (0)