org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.websocket.api.annotations;
import java.io.InputStream;
import java.io.Reader;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation for methods to receive BINARY or TEXT WebSocket events.
* Acceptable method patterns:
* Text Message Versions
*
* - {@code public void methodName(String text)}
* - {@code public void methodName(Session session, String text)}
* - {@code public void methodName(Reader reader)}
* - {@code public void methodName(Session session, Reader reader)}
*
* NOTE
* Method that takes a {@link Reader} must have
* {@link WebSocket#autoDemand()} set to {@code true}.
* NOTE
* The {@link Reader} argument will always use the UTF-8 charset,
* (as dictated by RFC 6455). If you need to use a different charset,
* you must use BINARY messages.
* Binary Message Versions
*
* - {@code public void methodName(ByteBuffer message, Callback callback)}
* - {@code public void methodName(Session session, ByteBuffer message, Callback callback)}
* - {@code public void methodName(InputStream stream)}
* - {@code public void methodName(Session session, InputStream stream)}
*
* NOTE
* Method that takes a {@link InputStream} must have
* {@link WebSocket#autoDemand()} set to {@code true}.
* Partial Message Variations
* These are used to receive individual frames (and therefore partial
* messages) without aggregating the frames into a complete WebSocket message.
* A {@code boolean} parameter is supplied to indicate whether the frame is
* the last segment of data of the message.
*
* - {@code public void methodName(ByteBuffer payload, boolean last, Callback callback)}
* - {@code public void methodName(Session session, ByteBuffer payload, boolean last, Callback callback)}
* - {@code public void methodName(String payload, boolean last)}
* - {@code public void methodName(Session session, String payload, boolean last)}
*
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OnWebSocketMessage
{
}