@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ClientEndpoint

 @ClientEndpoint(subprotocols="chat")
 public class HelloServer {
 @OnMessage
 public void processMessageFromServer(String message, Session session) {
 System.out.println("Message came from the server ! " + message);
 }
 }
 

Author:

dannycoward

• Optional Element Summary

  Optional Elements

  Modifier and Type	Optional Element and Description
  Class<? extends ClientEndpointConfig.Configurator>	configurator An optional custom configurator class that the developer would like to use to provide custom configuration of new instances of this endpoint.
  Class<? extends Decoder>[]	decoders The array of Java classes that are to act as Decoders for messages coming into the client.
  Class<? extends Encoder>[]	encoders The array of Java classes that are to act as Encoders for messages sent by the client.
  String[]	subprotocols The names of the subprotocols this client supports.

• Element Detail

  • subprotocols

    public abstract String[] subprotocols

    The names of the subprotocols this client supports.

    Returns:

    the array of names of the subprotocols.

    Default:

    {}

• • decoders

    public abstract Class<? extends Decoder>[] decoders

    The array of Java classes that are to act as Decoders for messages coming into the client.

    Returns:

    the array of decoders.

    Default:

    {}

• • encoders

    public abstract Class<? extends Encoder>[] encoders

    The array of Java classes that are to act as Encoders for messages sent by the client.

    Returns:

    the array of decoders.

    Default:

    {}

• • configurator

    public abstract Class<? extends ClientEndpointConfig.Configurator> configurator

    An optional custom configurator class that the developer would like to use to provide custom configuration of new instances of this endpoint. The implementation creates a new instance of the configurator per logical endpoint.

    Returns:

    the custom configurator class, or ClientEndpointConfigurator.class if none was provided in the annotation.

    Default:

    javax.websocket.ClientEndpointConfig.Configurator.class