API du serveur

Listeners de démarrage et d'arrêt du serveur

Socketio4j vous permet d'enregistrer des listeners pour les démarrages et arrêts d'événements. Les listeners sont exécutés en toute sécurité avec isolation des exceptions, garantissant que les échecs d'un listener n'affectent pas les autres ni le cycle de vie du serveur.

Listener de démarrage

Ajouter un listener de démarrage

ServerStartListener startListener = s -> {
    System.out.println(
        "Serveur démarré sur " + s.getConfiguration().getPort()
    );
};

server.addStartListener(startListener);

Supprimer le listener de démarrage

server.removeStartListener(startListener);

Listener d'arrêt

Ajouter un listener d'arrêt

ServerStopListener stopListener = s -> {
    System.out.println("Serveur arrêté");
};

server.addStopListener(stopListener);

Supprimer le listener d'arrêt

server.removeStopListener(stopListener);

Garanties d'exécution

• Les listeners de démarrage sont invoqués après que le serveur a démarré avec succès

• Les listeners d'arrêt sont invoqués lors d'un arrêt gracieux

• Chaque listener est exécuté avec isolation des exceptions

• Les exceptions levées par les listeners ne interrompent :

  • Le démarrage ou l'arrêt du serveur

  • Les autres listeners enregistrés

Bonnes pratiques

• Gardez la logique des listeners légère et non bloquante

• Évitez les opérations longues ou bloquantes à l'intérieur des listeners

• Utilisez les listeners uniquement pour la journalisation, les métriques et la coordination

Namespaces

Namespace par défaut

Le namespace racine ("/") est créé automatiquement.

Ajouter un namespace

SocketIONamespace chat = server.addNamespace("/chat");

Obtenir un namespace

SocketIONamespace chat = server.getNamespace("/chat");

Supprimer un namespace

server.removeNamespace("/chat");

Obtenir tous les namespaces

Collection<SocketIONamespace> namespaces = server.getAllNamespaces();

Clients

Obtenir tous les clients connectés (namespace par défaut)

Collection<SocketIOClient> clients = server.getAllClients();

Obtenir un client par ID de session

SocketIOClient client = server.getClient(uuid);

Retourne null si non trouvé.

Diffusion

Diffuser à tous les clients (tous les namespaces)

server.getBroadcastOperations()
      .sendEvent("announcement", "Bonjour à tous");

Diffuser vers des rooms (à travers tous les namespaces)

server.getRoomOperations("room1", "room2")
      .sendEvent("message", "Bonjour les rooms");

Listeners d'événements (namespace par défaut)

Listener d'événement (typé)

server.addEventListener("chat", Message.class, (client, data, ack) -> {
    System.out.println(data);
});

Listener d'événement multi-type

server.addMultiTypeEventListener(
    "event",
    (client, data, ack) -> {},
    String.class,
    ChatMessage.class
);

Listener catch-all

CatchAllEventListener anyListener = (client, event, args) -> {
    System.out.println("Événement : " + event);
};
// ajouter
server.addOnAnyEventListener(anyListener);

// supprimer
server.removeOnAnyEventListener(anyListener);

Alias :

• onAny(...)

• offAny(...)

Intercepteur d'événements

server.addEventInterceptor((client, event, args) -> {
    return true; // autoriser
});

Utilisé pour la validation, le filtrage ou les vérifications de sécurité.

Supprimer tous les listeners d'événements

server.removeAllListeners("eventName");

Listeners du cycle de vie de la connexion

Listener de connexion

server.addConnectListener(client -> {
    System.out.println("Connecté : " + client.getSessionId());
});

Listener de déconnexion

server.addDisconnectListener(client -> {
    System.out.println("Déconnecté");
});

Listeners Ping / Pong

server.addPingListener(client -> {});
server.addPongListener(client -> {});

Utile pour surveiller la santé des connexions.

Enregistrement automatique des listeners

Enregistrer un objet listener

server.addListeners(new ChatEventHandler());

Enregistrer avec une classe explicite

server.addListeners(new ChatEventHandler(), ChatEventHandler.class);

Prend en charge les listeners basés sur les annotations.

Consultez Événements pour plus de détails