javax.net.websocket

Interface MessageHandler

All Known Subinterfaces:

MessageHandler.AsyncBinary, MessageHandler.AsyncText, MessageHandler.Binary, MessageHandler.BinaryStream, MessageHandler.CharacterStream, MessageHandler.DecodedObject<T>, MessageHandler.Pong, MessageHandler.Text

All Known Implementing Classes:

MessageHandlerForBean

public interface MessageHandler

Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation. Each web socket session uses no more than one thread at a time to call its MessageHandlers. This means that, provided each message handler instance is used to handle messages for one web socket session, at most one thread at a time can be calling any of its methods. Developers who wish to handle messages from multiple clients within the same message handlers may do so by adding the same instance as a handler on each of the Session objects for the clients. In that case, they will need to code with the possibility of their MessageHandler being called concurrently by multiple threads, each one arising from a different client session.

Since:

DRAFT 001

Author:

dannycoward

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageHandler.AsyncBinary This kind of handler is called to process for binary messages which may arrive in multiple parts.
static interface	MessageHandler.AsyncText This kind of handler is called to process for text messages which may arrive in multiple parts.
static interface	MessageHandler.Binary This kind of listener listens for binary messages.
static interface	MessageHandler.BinaryStream This kind of handler is called when a new binary message arrives that is to be read using a blocking stream.
static interface	MessageHandler.CharacterStream This kind of handler is called when a new text message arrives that is to be read using a blocking stream.
static interface	MessageHandler.DecodedObject<T> This kind of listener listens for messages that the container knows how to decode into an object of type T.
static interface	MessageHandler.Pong This handler is called back by the container when the container receives a pong message.
static interface	MessageHandler.Text This kind of listener listens for text messages.