1 //
2 // ========================================================================
3 // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.websocket.api.annotations;
20
21 import java.io.Reader;
22 import java.lang.annotation.Documented;
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27
28 import org.eclipse.jetty.websocket.api.Session;
29
30 /**
31 * Annotation for tagging methods to receive Binary or Text Message events.
32 * <p>
33 * Acceptable method patterns.<br>
34 * Note: <code>methodName</code> can be any name you want to use.
35 * <p>
36 * <u>Text Message Versions</u>
37 * <ol>
38 * <li><code>public void methodName(String text)</code></li>
39 * <li><code>public void methodName({@link Session} session, String text)</code></li>
40 * <li><code>public void methodName(Reader reader)</code></li>
41 * <li><code>public void methodName({@link Session} session, Reader reader)</code></li>
42 * </ol>
43 * 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
44 * use a non-UTF-8 encoding/charset, you are instructed to use the binary messaging techniques.
45 * <p>
46 * <u>Binary Message Versions</u>
47 * <ol>
48 * <li><code>public void methodName(byte buf[], int offset, int length)</code></li>
49 * <li><code>public void methodName({@link Session} session, byte buf[], int offset, int length)</code></li>
50 * <li><code>public void methodName(InputStream stream)</code></li>
51 * <li><code>public void methodName({@link Session} session, InputStream stream)</code></li>
52 * </ol>
53 */
54 @Documented
55 @Retention(RetentionPolicy.RUNTIME)
56 @Target(value =
57 { ElementType.METHOD })
58 public @interface OnWebSocketMessage
59 {
60 /* no config */
61 }