org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2022 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.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;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.WebSocketPartialListener;
/**
* Annotation for tagging methods to receive Binary or Text Message events.
*
* Acceptable method patterns.
* Note: {@code methodName} can be any name you want to use.
*
* 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: that the {@link Reader} in this case will always use UTF-8 encoding/charset (this is dictated by the RFC 6455 spec for Text Messages. If you need to
* use a non-UTF-8 encoding/charset, you are instructed to use the binary messaging techniques.
* Binary Message Versions
*
* - {@code public void methodName(ByteBuffer message)}
* - {@code public void methodName(Session session, ByteBuffer message)}
* - {@code public void methodName(byte[] buf, int offset, int length)}
* - {@code public void methodName(Session session, byte[] buf, int offset, int length)}
* - {@code public void methodName(InputStream stream)}
* - {@code public void methodName(Session session, InputStream stream)}
*
* Partial Message Variations
* These are used to receive partial messages without aggregating them into a complete WebSocket message. Instead the a boolean
* argument is supplied to indicate whether this is the last segment of data of the message. See {@link WebSocketPartialListener}
* interface for more details on partial messages.
*
* - {@code public void methodName(ByteBuffer payload, boolean last)}
* - {@code public void methodName(String payload, boolean last)}
*
* Note: Similar to the signatures above these can all be used with an optional first {@link Session} parameter.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value =
{ElementType.METHOD})
public @interface OnWebSocketMessage
{
/* no config */
}