Class WebSocket

CodenameOne/src/com/codename1/io/WebSocket.java:50–285

/// Use [isSupported] to check at runtime whether the current port supports
/// WebSocket -- older ports return `false` and [build] will throw on them.
public final class WebSocket {

    /// Handler for the connection-established event.
    public interface ConnectHandler {
        void onConnect(WebSocket ws);
    }

    /// Handler for an incoming text frame.
    public interface TextHandler {
        void onText(WebSocket ws, String message);
    }

    /// Handler for an incoming binary frame.
    public interface BinaryHandler {
        void onBinary(WebSocket ws, byte[] message);
    }

    /// Handler for the close event.
    ///
    /// @param statusCode the RFC 6455 close status code (1000 = normal, etc.)
    /// @param reason     the human-readable reason, or empty string
    public interface CloseHandler {
        void onClose(WebSocket ws, int statusCode, String reason);
    }

    /// Handler for transport- or protocol-level errors. The connection is
    /// closed by the time this fires.
    public interface ErrorHandler {
        void onError(WebSocket ws, Exception ex);
    }

    private final WebSocketImpl impl;
    // Handlers are assigned from the thread that configures the socket and
    // read from the background dispatch thread, so they are volatile to
    // publish writes across threads.
    @SuppressWarnings("PMD.AvoidUsingVolatile")
    private volatile ConnectHandler connectHandler;
    @SuppressWarnings("PMD.AvoidUsingVolatile")
    private volatile TextHandler textHandler;
    @SuppressWarnings("PMD.AvoidUsingVolatile")
    private volatile BinaryHandler binaryHandler;
    @SuppressWarnings("PMD.AvoidUsingVolatile")
    private volatile CloseHandler closeHandler;
    @SuppressWarnings("PMD.AvoidUsingVolatile")
    private volatile ErrorHandler errorHandler;

    private WebSocket(WebSocketImpl impl) {
        this.impl = impl;
        final WebSocket self = this;
        impl.setEventSink(new WebSocketEventSink() {
            @Override
            public void onConnect() {
                ConnectHandler h = connectHandler;
                if (h != null) {
                    try {
                        h.onConnect(self);
                    } catch (Throwable t) {
                        dispatchError(t);