Package | Description |
---|---|
javax.websocket |
This package contains all the 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.server |
Server implementation.
|
Modifier and Type | Method and Description |
---|---|
Session |
WebSocketContainer.connectToServer(Class<?> annotatedEndpointClass,
URI path)
Connect the supplied annotated endpoint to its server.
|
Session |
WebSocketContainer.connectToServer(Class<? extends Endpoint> endpointClass,
ClientEndpointConfig cec,
URI path)
Connect the supplied programmatic endpoint to its server with the given configuration.
|
Session |
WebSocketContainer.connectToServer(Endpoint endpointInstance,
ClientEndpointConfig cec,
URI path)
Connect the supplied programmatic client endpoint instance to its server with the given configuration.
|
Session |
WebSocketContainer.connectToServer(Object annotatedEndpointInstance,
URI path)
Connect the supplied annotated endpoint instance to its server.
|
Session |
SessionException.getSession()
Return the Session on which the problem occurred.
|
Modifier and Type | Method and Description |
---|---|
Set<Session> |
Session.getOpenSessions()
Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to
which this session represents a connection.
|
Modifier and Type | Method and Description |
---|---|
void |
Endpoint.onClose(Session session,
CloseReason closeReason)
This method is called immediately prior to the session with the remote peer being closed.
|
void |
Endpoint.onError(Session session,
Throwable thr)
Developers may implement this method when the web socket session creates some kind of error that is not modeled
in the web socket protocol.
|
abstract void |
Endpoint.onOpen(Session session,
EndpointConfig config)
Developers must implement this method to be notified when a new conversation has just begun.
|
Constructor and Description |
---|
SessionException(String message,
Throwable cause,
Session session)
Creates a new instance of this exception with the given message, the wrapped cause of the exception and the
session with which the problem is associated.
|
Modifier and Type | Method and Description |
---|---|
Session |
ClientManager.connectToServer(Class<? extends Endpoint> endpointClass,
ClientEndpointConfig cec,
URI path) |
Session |
ClientManager.connectToServer(Class annotatedEndpointClass,
URI path) |
Session |
ClientManager.connectToServer(Endpoint endpointInstance,
ClientEndpointConfig cec,
URI path) |
Session |
ClientManager.connectToServer(Object obj,
URI path) |
Modifier and Type | Method and Description |
---|---|
Future<Session> |
ClientManager.asyncConnectToServer(Class<?> annotatedEndpointClass,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Class, java.net.URI) . |
Future<Session> |
ClientManager.asyncConnectToServer(Class<? extends Endpoint> endpointClass,
ClientEndpointConfig cec,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Class, javax.websocket.ClientEndpointConfig,
java.net.URI) . |
Future<Session> |
ClientManager.asyncConnectToServer(Endpoint endpointInstance,
ClientEndpointConfig cec,
URI path)
|
Future<Session> |
ClientManager.asyncConnectToServer(Object obj,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Object, java.net.URI) . |
Modifier and Type | Method and Description |
---|---|
void |
TyrusClientEngine.ClientHandshakeListener.onSessionCreated(Session session)
Invoked when handshake is completed and provided
Session is open and ready to be returned from
WebSocketContainer.connectToServer(Class, javax.websocket.ClientEndpointConfig, java.net.URI) (and
alternatives) call. |
Modifier and Type | Class and Description |
---|---|
class |
TyrusSession
Implementation of the
Session . |
Modifier and Type | Method and Description |
---|---|
Session |
TyrusEndpointWrapper.createSessionForRemoteEndpoint(TyrusWebSocket socket,
String subprotocol,
List<Extension> extensions,
DebugContext debugContext)
Creates a Session based on the
TyrusWebSocket , subprotocols and extensions. |
Modifier and Type | Method and Description |
---|---|
Map<Session,Future<?>> |
TyrusSession.broadcast(ByteBuffer message)
Broadcasts binary message to all connected clients, including remote sessions (if any).
|
Map<Session,Future<?>> |
TyrusSession.broadcast(String message)
Broadcasts text message to all connected clients.
|
Set<Session> |
TyrusSession.getOpenSessions() |
Modifier and Type | Method and Description |
---|---|
Object |
TyrusEndpointWrapper.doEncode(Session session,
Object message) |
<T> Object |
ComponentProviderService.getCoderInstance(Class<T> c,
Session session,
EndpointConfig endpointConfig,
ErrorCollector collector)
|
<T> Object |
ComponentProviderService.getInstance(Class<T> c,
Session session,
ErrorCollector collector)
Provide an instance of class which is coupled to
Session . |
void |
AnnotatedEndpoint.onClose(Session session,
CloseReason closeReason) |
void |
AnnotatedEndpoint.onError(Session session,
Throwable thr) |
void |
AnnotatedEndpoint.onOpen(Session session,
EndpointConfig configuration) |
void |
ComponentProviderService.removeSession(Session session)
Remove
Session from cache. |
Modifier and Type | Interface and Description |
---|---|
interface |
DistributedSession
Extended
Session which adds distributed properties. |
Modifier and Type | Class and Description |
---|---|
class |
RemoteSession
Remote session represents session originating from another node.
|
Modifier and Type | Method and Description |
---|---|
Set<Session> |
RemoteSession.getOpenSessions()
This method is not supported on
RemoteSession . |
Constructor and Description |
---|
RemoteSession(String sessionId,
ClusterContext clusterContext,
Map<RemoteSession.DistributedMapKey,Object> distributedPropertyMap,
TyrusEndpointWrapper endpointWrapper,
Session session)
Constructor.
|
SessionEventListener(Session session)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Session |
TyrusServerContainer.connectToServer(Class<? extends Endpoint> endpointClass,
ClientEndpointConfig cec,
URI path) |
Session |
TyrusServerContainer.connectToServer(Class annotatedEndpointClass,
URI path) |
Session |
TyrusServerContainer.connectToServer(Endpoint endpointInstance,
ClientEndpointConfig cec,
URI path) |
Session |
TyrusServerContainer.connectToServer(Object annotatedEndpointInstance,
URI path) |
Modifier and Type | Method and Description |
---|---|
Future<Session> |
TyrusServerContainer.asyncConnectToServer(Class<?> annotatedEndpointClass,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Class, java.net.URI) . |
Future<Session> |
TyrusServerContainer.asyncConnectToServer(Class<? extends Endpoint> endpointClass,
ClientEndpointConfig cec,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Class,
javax.websocket.ClientEndpointConfig, java.net.URI) . |
Future<Session> |
TyrusServerContainer.asyncConnectToServer(Endpoint endpointInstance,
ClientEndpointConfig cec,
URI path)
|
Future<Session> |
TyrusServerContainer.asyncConnectToServer(Object obj,
URI path)
Non-blocking version of
WebSocketContainer.connectToServer(Object, java.net.URI) . |
Copyright © 2012–2019 Oracle Corporation. All rights reserved.