1 //
2 // ========================================================================
3 // Copyright (c) 1995-2013 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 import org.eclipse.jetty.websocket.api.WebSocketConnection;
28
29 /**
30 * (ADVANCED) Annotation for tagging methods to receive frame events.
31 * <p>
32 * Note: any frame derived from {@link WebSocketFrame} is acceptable to use as the last parameter here.
33 * <p>
34 * Acceptable method patterns.<br>
35 * Note: <code>methodName</code> can be any name you want to use.
36 * <ol>
37 * <li><code>public void methodName({@link WebSocketFrame} frame)</code></li>
38 * <li><code>public void methodName({@link WebSocketConnection} conn, {@link WebSocketFrame} frame)</code></li>
39 * </ol>
40 */
41 @Documented
42 @Retention(RetentionPolicy.RUNTIME)
43 @Target(value =
44 { ElementType.METHOD })
45 public @interface OnWebSocketFrame
46 {
47 /* no config */
48 }