1 //
2 // ========================================================================
3 // Copyright (c) 1995-2014 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.lang.annotation.Documented;
22 import java.lang.annotation.ElementType;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26
27 /**
28 * Annotation for tagging methods to receive Binary or Text Message events.
29 * <p>
30 * Acceptable method patterns.<br>
31 * Note: <code>methodName</code> can be any name you want to use.
32 * <p>
33 * <u>Text Message Versions</u>
34 * <ol>
35 * <li><code>public void methodName(String text)</code></li>
36 * <li><code>public void methodName({@link Session} session, String text)</code></li>
37 * <li><code>public void methodName(Reader reader)</code></li>
38 * <li><code>public void methodName({@link Session} session, Reader reader)</code></li>
39 * </ol>
40 * 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
41 * use a non-UTF-8 encoding/charset, you are instructed to use the binary messaging techniques.
42 * <p>
43 * <u>Binary Message Versions</u>
44 * <ol>
45 * <li><code>public void methodName(byte buf[], int offset, int length)</code></li>
46 * <li><code>public void methodName({@link Session} session, byte buf[], int offset, int length)</code></li>
47 * <li><code>public void methodName(InputStream stream)</code></li>
48 * <li><code>public void methodName({@link Session} session, InputStream stream)</code></li>
49 * </ol>
50 */
51 @Documented
52 @Retention(RetentionPolicy.RUNTIME)
53 @Target(value =
54 { ElementType.METHOD })
55 public @interface OnWebSocketMessage
56 {
57 /* no config */
58 }