org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of websocket-api Show documentation

There is a newer version: 9.4.56.v20240826

//
//  ========================================================================
//  Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

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;

/**
 * Annotation for tagging methods to receive Binary or Text Message events.
 * 
 * Acceptable method patterns.

 * Note: methodName can be any name you want to use.
 * 

 * Text Message Versions
 * 

 * public void methodName(String text)
 * public void methodName({@link Session} session, String text)
 * public void methodName(Reader reader)
 * public void methodName({@link 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
 * 

 * public void methodName(byte buf[], int offset, int length)
 * public void methodName({@link Session} session, byte buf[], int offset, int length)
 * public void methodName(InputStream stream)
 * public void methodName({@link Session} session, InputStream stream)
 * 
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value =
    {ElementType.METHOD})
public @interface OnWebSocketMessage
{
    /* no config */
}