API del servidor

Detectores de inicio y parada del servidor

Socketio4j te permite registrar detectores para los eventos del servidor inicio y parada eventos. Los detectores se ejecutan de forma segura con aislamiento de excepciones, garantizando que las fallas en un detector no afecten a otros ni al ciclo de vida del servidor.

Detector de inicio

Agregar detector de inicio

ServerStartListener startListener = s -> {
    System.out.println(
        "Servidor iniciado en " + s.getConfiguration().getPort()
    );
};

server.addStartListener(startListener);

Eliminar detector de inicio

server.removeStartListener(startListener);

Detector de parada

Agregar detector de parada

ServerStopListener stopListener = s -> {
    System.out.println("Servidor detenido");
};

server.addStopListener(stopListener);

Eliminar detector de parada

server.removeStopListener(stopListener);

Garantías de ejecución

• Los detectores de inicio se invocan después de que el servidor se haya iniciado correctamente

• Los detectores de parada se invocan durante el apagado ordenado

• Cada detector se ejecuta con aislamiento de excepciones

• Las excepciones lanzadas por los detectores no interrumpen:

  • El inicio o apagado del servidor

  • Otros detectores registrados

Mejores prácticas

• Mantén la lógica del detector ligera y no bloqueante

• Evita operaciones de larga duración o bloqueantes dentro de los detectores

• Usa detectores solo para registro, métricas y coordinación

Namespaces

Namespace predeterminado

El namespace raíz ("/") se crea automáticamente.

Agregar namespace

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

Obtener namespace

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

Eliminar namespace

server.removeNamespace("/chat");

Obtener todos los namespaces

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

Clientes

Obtener todos los clientes conectados (namespace predeterminado)

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

Obtener cliente por ID de sesión

SocketIOClient client = server.getClient(uuid);

Devuelve null si no se encuentra.

Transmisión

Transmitir a todos los clientes (todos los namespaces)

server.getBroadcastOperations()
      .sendEvent("announcement", "Hola a todos");

Transmitir a salas (a través de todos los namespaces)

server.getRoomOperations("room1", "room2")
      .sendEvent("message", "Hola salas");

Detectores de eventos (namespace predeterminado)

Detector de eventos (tipado)

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

Detector de eventos de múltiples tipos

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

Detector que captura todo

CatchAllEventListener anyListener = (client, event, args) -> {
    System.out.println("Evento: " + event);
};
// agregar
server.addOnAnyEventListener(anyListener);

// eliminar
server.removeOnAnyEventListener(anyListener);

Alias:

• onAny(...)

• offAny(...)

Interceptor de eventos

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

Se utiliza para validación, filtrado o comprobaciones de seguridad.

Eliminar todos los detectores de eventos

server.removeAllListeners("eventName");

Detectores del ciclo de vida de la conexión

Detector de conexión

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

Detector de desconexión

server.addDisconnectListener(client -> {
    System.out.println("Desconectado");
});

Detectores Ping / Pong

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

Útil para monitorizar la salud de la conexión.

Auto-registro de detectores

Registrar objeto detector

server.addListeners(new ChatEventHandler());

Registrar con clase explícita

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

Admite detectores basados en anotaciones.

Consulta Eventos para más detalles