async websocket onOpen, onError and onClose in 10.0.x

[gregw]

No description provided.

[joakime]

Some test cases for you to work out ...

The onOpen throws an exception.

import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

@ServerEndpoint("fastfail")
public class FastFailSocket
{
    @OnOpen
    public void onOpen(Session session)
    {
        throw new RuntimeException("Intentional exception");
    }
}

The onOpen closes the connection.

import java.io.IOException;
import javax.websocket.CloseReason;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

@ServerEndpoint("fastclose")
public class FastCloseSocket
{
    @OnOpen
    public void onOpen(Session session)
    {
        try
        {
            session.close(new CloseReason(CloseReason.CloseCodes.TRY_AGAIN_LATER, "I'm not ready yet, shoo."));
        }
        catch (IOException e)
        {
            throw new RuntimeException("Ooops, unable to send close frame", e);
        }
    }
}

or a endpoint that just harshly disconnects.

import java.io.IOException;

import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
import org.eclipse.jetty.websocket.api.annotations.WebSocket;

@WebSocket
public class DropConnectionSocket
{
    @OnWebSocketConnect
    public void onConnect(Session session)
    {
        try
        {
            session.disconnect();
        }
        catch (IOException e)
        {
            throw new RuntimeException("Oops, unable to disconnect??", e);
        }
    }
}

Be sure to test the onClose and onError from both the server and client on these.

[joakime]

Jetty 9.4.x has a testcase that also ensures that the connections (and sessions) are cleaned up properly.

https://github.com/eclipse/jetty.project/blob/jetty-9.4.x/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ManyConnectionsCleanupTest.java

[joakime]

There is also the slow onOpen/onConnect method ...

import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;

import org.eclipse.jetty.websocket.api.RemoteEndpoint;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage;
import org.eclipse.jetty.websocket.api.annotations.WebSocket;

@WebSocket
public class SlowOpenSocket
{
    private final AtomicBoolean stillInOnOpen = new AtomicBoolean(true);

    @OnWebSocketConnect
    public void onConnect(Session session)
    {
        try
        {
            RemoteEndpoint remote = session.getRemote();
            remote.sendString("hello");
            TimeUnit.SECONDS.sleep(2);
            remote.sendString("there");
            TimeUnit.SECONDS.sleep(2);
            remote.sendString("how's");
            TimeUnit.SECONDS.sleep(2);
            remote.sendString("it");
            TimeUnit.SECONDS.sleep(2);
            remote.sendString("going?");
            stillInOnOpen.compareAndSet(true, false);
        }
        catch (Exception e)
        {
            throw new RuntimeException("Ooops, unable to send opening messages", e);
        }
    }

    @OnWebSocketMessage
    public void onMessage(Session session, String msg)
    {
        if (stillInOnOpen.get())
        {
            throw new RuntimeException("Shouldn't have received messages yet");
        }
    }
}