| Package | Description | 
|---|---|
| jakarta.websocket | This package contains all the Jakartq WebSocket APIs common to both the client and server side. | 
| jakarta.websocket.server | This package contains all the Jakarta WebSocket APIs used only by server side applications. | 
| org.glassfish.tyrus.core | Core classes. | 
| org.glassfish.tyrus.core.coder | Encoder and decoder adapters and built-in implementations. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ClientEndpointConfigThe ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration
 information specific only to client endpoints. | 
| Modifier and Type | Method and Description | 
|---|---|
| default void | Decoder. init(EndpointConfig config)This method is called with the endpoint configuration object of the endpoint this decoder is intended for when it
 is about to be brought into service. | 
| default void | Encoder. init(EndpointConfig config)This method is called with the endpoint configuration object of the endpoint this encoder is intended for when it
 is about to be brought into service. | 
| abstract void | Endpoint. onOpen(Session session,
      EndpointConfig config)Developers must implement this method to be notified when a new conversation has just begun. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ServerEndpointConfigThe ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration
 information specific only to server endpoints. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | TyrusServerEndpointConfigConfiguration  ServerEndpointConfigenhanced
 to offer tyrus specific attributes like maxSessions. | 
| Modifier and Type | Method and Description | 
|---|---|
| EndpointConfig | AnnotatedEndpoint. getEndpointConfig() | 
| EndpointConfig | TyrusEndpointWrapper. getEndpointConfig()Get Endpoint configuration. | 
| Modifier and Type | Method and Description | 
|---|---|
| <T> java.lang.Object | ComponentProviderService. getCoderInstance(java.lang.Class<T> c,
                Session session,
                EndpointConfig endpointConfig,
                ErrorCollector collector) | 
| void | AnnotatedEndpoint. onOpen(Session session,
      EndpointConfig configuration) | 
| Constructor and Description | 
|---|
| TyrusEndpointWrapper(java.lang.Class<? extends Endpoint> endpointClass,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    java.lang.String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener,
                    java.lang.Boolean parallelBroadcastEnabled)Create  TyrusEndpointWrapperfor class that extendsEndpoint. | 
| TyrusEndpointWrapper(Endpoint endpoint,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    java.lang.String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener,
                    java.lang.Boolean parallelBroadcastEnabled) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | CoderAdapter. init(EndpointConfig config)This method does nothing. | 
Copyright © 2012–2020 Oracle Corporation. All rights reserved.