io.quarkus.websockets.next.OpenClientConnections Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-websockets-next Show documentation

Implementation of the WebSocket API with enhanced efficiency and usability

There is a newer version: 3.17.2

Show newest version

package io.quarkus.websockets.next;

import java.util.Collection;
import java.util.Optional;
import java.util.stream.Stream;

import jakarta.enterprise.inject.Default;

import io.smallrye.common.annotation.Experimental;

/**
 * Provides convenient access to all open client connections.
 * 
 * Quarkus provides a CDI bean with bean type {@link OpenClientConnections} and qualifier {@link Default}.
 */
@Experimental("This API is experimental and may change in the future")
public interface OpenClientConnections extends Iterable {

    /**
     * Returns an immutable snapshot of all open connections at the given time.
     *
     * @return an immutable collection of all open connections
     */
    default Collection listAll() {
        return stream().toList();
    }

    /**
     * Returns an immutable snapshot of all open connections for the given client id.
     *
     * @param endpointId
     * @return an immutable collection of all open connections for the given client id
     * @see WebSocketClient#clientId()
     */
    default Collection findByClientId(String clientId) {
        return stream().filter(c -> c.clientId().equals(clientId)).toList();
    }

    /**
     * Returns the open connection with the given id.
     *
     * @param connectionId
     * @return the open connection or empty {@link Optional} if no open connection with the given id exists
     * @see WebSocketConnection#id()
     */
    default Optional findByConnectionId(String connectionId) {
        return stream().filter(c -> c.id().equals(connectionId)).findFirst();
    }

    /**
     * Returns the stream of all open connections at the given time.
     *
     * @return the stream of open connections
     */
    Stream stream();

}