io.quarkus.websockets.next.BinaryMessageCodec 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 io.smallrye.common.annotation.Experimental;
import io.vertx.core.buffer.Buffer;

/**
 * Used to encode and decode binary messages.
 *
 * Special types of messages
 *
 * Some types of messages bypass the encoding/decoding process:
 * 
 * {@code io.vertx.core.buffer.Buffer},
 * {@code byte[]},
 * {@code java.lang.String},
 * {@code io.vertx.core.json.JsonObject}.
 * {@code io.vertx.core.json.JsonArray}.
 * 
 * The encoding/decoding details are described in {@link OnBinaryMessage}.
 *
 * CDI beans
 * Implementation classes must be CDI beans. Qualifiers are ignored. {@link jakarta.enterprise.context.Dependent} beans are
 * reused during encoding/decoding.
 *
 * Lifecycle and concurrency
 * Codecs are shared accross all WebSocket connections. Therefore, implementations should be either stateless or thread-safe.
 *
 * @param 
 * @see OnBinaryMessage
 */
@Experimental("This API is experimental and may change in the future")
public interface BinaryMessageCodec extends MessageCodec {

}