@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface ClientEndpoint
jakarta.websocket.server.ServerEndpoint, POJOs that are annotated with this
annotation can have methods that, using the web socket method level annotations, are web socket lifecycle methods.
For example:
@ClientEndpoint(subprotocols="chat")
public class HelloServer {
@OnMessage
public void processMessageFromServer(String message, Session session) {
System.out.println("Message came from the server ! " + message);
}
}
| Modifier and Type | Optional Element and Description |
|---|---|
java.lang.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.
|
java.lang.Class<? extends Decoder>[] |
decoders
The array of Java classes that are to act as Decoders for messages coming into the client.
|
java.lang.Class<? extends Encoder>[] |
encoders
The array of Java classes that are to act as Encoders for messages sent by the client.
|
java.lang.String[] |
subprotocols
The names of the subprotocols this client supports.
|
public abstract java.lang.String[] subprotocols
public abstract java.lang.Class<? extends Decoder>[] decoders
public abstract java.lang.Class<? extends Encoder>[] encoders
public abstract java.lang.Class<? extends ClientEndpointConfig.Configurator> configurator