Un simple client WebSocket pour Dart qui inclut une logique de reconnexion automatique

Un simple WebSocket client pour Dart qui inclut une logique de reconnexion automatique.

Démarrage rapide 🚀

// Create a WebSocket client.
final socket = WebSocket(Uri.parse('ws://localhost:8080'));

// Listen to messages from the server.
socket.messages.listen((message) {
  // Handle incoming messages.
});

// Send a message to the server.
socket.send('ping');

// Close the connection.
socket.close();

Établir une connexion 🔌

La WebSocket client tentera d’établir une connexion immédiatement après l’initialisation. Par défaut, un délai d’attente se produira si l’établissement d’une connexion dépasse 60 secondes mais un timeout la durée peut être indiquée :

final uri = Uri.parse('ws://localhost:8080');

// Trigger a timeout if establishing a connection exceeds 10s.
final timeout = Duration(seconds: 10);
final socket = WebSocket(uri, timeout: timeout);

Reconnexion 🔄

Si la WebSocket client n’est pas en mesure d’établir une connexion, il tentera automatiquement de se reconnecter en utilisant le Backoff stratégie. Par défaut, un BinaryExponentialBackoff est utilisé mais une coutume backoff peut être fourni.

Il existe trois stratégies d’interruption intégrées, mais une stratégie d’interruption personnalisée peut être écrite en implémentant le Backoff interface.

ConstantBackoff

Cette stratégie de retrait rendra le WebSocket le client attend un laps de temps constant entre les tentatives de reconnexion.

// Wait a constant 1s between reconnection attempts.
// [1, 1, 1, ...]
const backoff = ConstantBackoff(Duration(seconds: 1));
final socket = WebSocket(uri, backoff: backoff);

Interruption linéaire

Cette stratégie de retrait rendra le WebSocket le client attend un temps croissant de manière linéaire jusqu’à ce qu’une durée maximale facultative soit atteinte.

// Initially wait 0s and increase the wait time by 1s until a maximum of 5s is reached.
// [0, 1, 2, 3, 4, 5, 5, 5, ...]
const backoff = LinearBackoff(
  initial: Duration(seconds: ),
  increment: Duration(seconds: 1),
  maximum: Duration(seconds: 5),
);
final socket = WebSocket(uri, backoff: backoff);

BinaryExponentialBackoff

Cette stratégie de retrait rendra le WebSocket le client attend un temps de plus en plus exponentiel jusqu’à ce qu’une étape maximale soit atteinte.

// Initially wait 1s and double the wait time until a maximum step of of 3 is reached.
// [1, 2, 4, 4, 4, ...]
const backoff = BinaryExponentialBackoff(
  initial: Duration(seconds: 1),  
  maximumStep: 3
);
final socket = WebSocket(uri, backoff: backoff);

Surveillance de la connexion ⚡️

La WebSocket le client expose un connection objet qui peut être utilisé pour interroger l’état de la connexion à un moment donné ainsi que pour écouter les changements en temps réel de l’état de la connexion.

final uri = Uri.parse('ws://localhost:8080');
final socket = WebSocket(uri);

// Listen to changes in the connection state.
socket.connection.listen((state) {
  // Handle changes in the connection state.
});

// Query the current connection state.
final connectionState = socket.connection.state;

L’état de la connexion peut être l’un des suivants :

de liaison: la connexion n’a pas encore été établie.
lié: la connexion est établie et la communication est possible.
se reconnecter: la connexion a été perdue et est en cours de rétablissement.
reconnecté: la connexion a été perdue et a été rétablie.
déconnexion: la connexion passe par la poignée de main de fermeture ou la close méthode a été invoquée.
débranché: la connexion WebSocket a été fermée ou n’a pas pu être établie.

* L’état de connexion déconnecté contient des champs nullables pour le code de fermeture, le motif de fermeture, l’erreur et la trace de la pile.

Envoi de messages 📤

Une fois par WebSocket connexion a été établie, des messages peuvent être envoyés au serveur via send:

final socket = WebSocket(Uri.parse('ws://localhost:8080'));

// Wait until a connection has been established.
await socket.connection.firstWhere((state) => state is Connected);

// Send a message to the server.
socket.send('ping');

Réception de messages 📥

Écoutez les messages entrants du serveur via le messages flux:

final socket = WebSocket(Uri.parse('ws://localhost:8080'));

// Listen for incoming messages.
socket.message.listen((message) {
  // Handle the incoming message.
});

Fermeture de la connexion 🚫

Une fois par WebSocket connexion est établie, il tentera automatiquement de se reconnecter si la connexion est interrompue. Appel close() mettra à jour l’état de la connexion à disconnectingeffectuez la poignée de main de fermeture et définissez l’état sur disconnected. À ce stade, le WebSocket le client ne tentera pas de se reconnecter et un nouveau WebSocket Une instance client devra être créée afin d’établir une nouvelle connexion.

final socket = WebSocket(Uri.parse('ws://localhost:8080'));

// Later, close the connection with an optional code and reason.
socket.close(1000, 'CLOSE_NORMAL');