| Package | Description | 
|---|---|
| jakarta.websocket | This package contains all the Jakartq WebSocket APIs common to both the client and server side. | 
| org.glassfish.tyrus.client | Common Client. | 
| org.glassfish.tyrus.core | Core classes. | 
| org.glassfish.tyrus.core.cluster | Cluster relates classes and interfaces. | 
| org.glassfish.tyrus.core.frame | WebSocket frame representations. | 
| org.glassfish.tyrus.spi | Tyrus SPI. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | Session. close(CloseReason closeReason)Close the current conversation, giving a reason for the closure. | 
| void | Endpoint. onClose(Session session,
       CloseReason closeReason)This method is called immediately prior to the session with the remote peer being closed. | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | ClientManager.ReconnectHandler. onDisconnect(CloseReason closeReason)Called after  OnCloseannotated method (orEndpoint.onClose(jakarta.websocket.Session, jakarta.websocket.CloseReason)is invoked. | 
| Modifier and Type | Method and Description | 
|---|---|
| static CloseReason | CloseReasons. create(CloseReason.CloseCode closeCode,
      java.lang.String reasonPhrase) | 
| CloseReason | CloseReasons. getCloseReason()Get close reason. | 
| CloseReason | ProtocolException. getCloseReason() | 
| CloseReason | Utf8DecodingException. getCloseReason() | 
| abstract CloseReason | WebSocketException. getCloseReason()Get close reason. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | TyrusRemoteEndpoint. close(CloseReason cr) | 
| void | TyrusSession. close(CloseReason closeReason) | 
| void | TyrusWebSocket. close(CloseReason closeReason)Closes this  TyrusWebSocketusing theCloseReason. | 
| void | AnnotatedEndpoint. onClose(Session session,
       CloseReason closeReason) | 
| void | TyrusEndpointWrapper.SessionListener. onClose(TyrusSession session,
       CloseReason closeReason)Invoked after  OnCloseannotated method
 orEndpoint.onClose(jakarta.websocket.Session, jakarta.websocket.CloseReason)execution. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | RemoteSession. close(CloseReason closeReason)Close the current conversation, giving a reason for the closure. | 
| abstract java.util.concurrent.Future<java.lang.Void> | ClusterContext. close(java.lang.String sessionId,
     CloseReason closeReason)Close remote session with custom  CloseReason. | 
| void | SessionEventListener. onClose(CloseReason closeReason)Invoked on session close event. | 
| Modifier and Type | Method and Description | 
|---|---|
| CloseReason | CloseFrame. getCloseReason()Get close reason. | 
| Constructor and Description | 
|---|
| CloseFrame(CloseReason closeReason)Constructor. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | Connection. close(CloseReason reason)Notifies tyrus that underlying transport is closing the connection. | 
| void | Connection.CloseListener. close(CloseReason reason)Tyrus notifies that logical connection is closed. | 
Copyright © 2012–2020 Oracle Corporation. All rights reserved.