MessageHandler.Whole (Java(TM) EE 7 Specification APIs) (original) (raw)

• Type Parameters:
  T - The type of the message object that this MessageHandler will consume.
  All Superinterfaces:
  MessageHandler
  Enclosing interface:
  MessageHandler

public static interface MessageHandler.Whole
extends MessageHandler
This kind of handler is notified by the container on arrival of a complete message. If the message is received in parts, the container buffers it until it is has been fully received before this method is called.
For handling incoming text messages, the allowed types for T are

• String

• Reader

• any developer object for which there is a corresponding Decoder.Text orDecoder.TextStream configured
  For handling incoming binary messages, the allowed types for T are

• ByteBuffer

• byte[]

• InputStream

• any developer object for which there is a corresponding Decoder.Binary orDecoder.BinaryStream configured
  For handling incoming pong messages, the type of T is PongMessage
  Developers should not continue to reference message objects of type Reader, ByteBuffer or InputStream after the completion of the onMessage() call, since they may be recycled by the implementation.

• • Nested Class Summary

     * ### Nested classes/interfaces inherited from interface javax.websocket.[MessageHandler](../../javax/websocket/MessageHandler.html "interface in javax.websocket")  
     `[MessageHandler.Partial](../../javax/websocket/MessageHandler.Partial.html "interface in javax.websocket")<[T](../../javax/websocket/MessageHandler.Partial.html "type parameter in MessageHandler.Partial")>, [MessageHandler.Whole](../../javax/websocket/MessageHandler.Whole.html "interface in javax.websocket")<[T](../../javax/websocket/MessageHandler.Whole.html "type parameter in MessageHandler.Whole")>`  

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method and Description
  void	onMessage(T message) Called when the message has been fully received.

• • Method Detail

     * #### onMessage  
     void onMessage([T](../../javax/websocket/MessageHandler.Whole.html "type parameter in MessageHandler.Whole") message)  
     Called when the message has been fully received.  
     Parameters:  
     `message` \- the message data.

Copyright © 1996-2015, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.