org.eclipse.jetty.websocket.api.annotations

Annotation Type OnWebSocketMessage

@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface OnWebSocketMessage

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

1. public void methodName(String text)
2. public void methodName(Session session, String text)
3. public void methodName(Reader reader)
4. public void methodName(Session session, Reader reader)

Note: that the 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

1. public void methodName(byte buf[], int offset, int length)
2. public void methodName(Session session, byte buf[], int offset, int length)
3. public void methodName(InputStream stream)
4. public void methodName(Session session, InputStream stream)