io.quarkus.websockets.next.runtime.WebSocketEndpoint 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.runtime;

import java.lang.reflect.Type;

import io.quarkus.websockets.next.InboundProcessingMode;
import io.smallrye.mutiny.Uni;
import io.vertx.core.Future;
import io.vertx.core.buffer.Buffer;

/**
 * Internal representation of a WebSocket endpoint.
 * 
 * A new instance is created for each connection.
 */
public interface WebSocketEndpoint {

    /**
     *
     * @return the inbound processing mode
     */
    InboundProcessingMode inboundProcessingMode();

    // @OnOpen

    Future onOpen();

    default ExecutionModel onOpenExecutionModel() {
        return ExecutionModel.NONE;
    }

    // @OnTextMessage

    Future onTextMessage(Object message);

    default ExecutionModel onTextMessageExecutionModel() {
        return ExecutionModel.NONE;
    }

    default Type consumedTextMultiType() {
        return null;
    }

    default Object decodeTextMultiItem(Object message) {
        throw new UnsupportedOperationException();
    }

    // @OnBinaryMessage

    Future onBinaryMessage(Object message);

    default ExecutionModel onBinaryMessageExecutionModel() {
        return ExecutionModel.NONE;
    }

    default Type consumedBinaryMultiType() {
        return null;
    }

    default Object decodeBinaryMultiItem(Object message) {
        throw new UnsupportedOperationException();
    }

    // @OnPongMessage

    Future onPongMessage(Buffer message);

    default ExecutionModel onPongMessageExecutionModel() {
        return ExecutionModel.NONE;
    }

    // @OnClose

    Future onClose();

    default ExecutionModel onCloseExecutionModel() {
        return ExecutionModel.NONE;
    }

    Uni doOnError(Throwable t);

    /**
     *
     * @return the identifier of the bean with callbacks
     * @see io.quarkus.arc.InjectableBean#getIdentifier()
     */
    String beanIdentifier();

    enum ExecutionModel {
        WORKER_THREAD,
        VIRTUAL_THREAD,
        EVENT_LOOP,
        NONE;

        boolean isBlocking() {
            return this == WORKER_THREAD || this == VIRTUAL_THREAD;
        }
    }

}