Class Endpoint

java.lang.Object

jakarta.websocket.Endpoint

public abstract class Endpoint
extends Object

Base class for programmatic WebSocket endpoints. Subclasses must implement the onOpen(Session, EndpointConfig) method to handle new connections.

Constructor Summary

Constructors

Constructor	Description
Endpoint()	Creates a new Endpoint instance.

Method Summary

Modifier and Type	Method	Description
void	onClose(Session session, CloseReason closeReason)	Event that is triggered when a session has closed.
void	onError(Session session, Throwable throwable)	Event that is triggered when a protocol error occurs.
abstract void	onOpen(Session session, EndpointConfig config)	Event that is triggered when a new session starts.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Endpoint

public Endpoint()

Creates a new Endpoint instance.

Method Details

onOpen

public abstract void onOpen(Session session,
 EndpointConfig config)

Event that is triggered when a new session starts.

Parameters:

session - The new session.

config - The configuration with which the Endpoint was configured.

onClose

public void onClose(Session session,
 CloseReason closeReason)

Event that is triggered when a session has closed.

Parameters:

session - The session

closeReason - Why the session was closed

onError

public void onError(Session session,
 Throwable throwable)

Event that is triggered when a protocol error occurs.

Parameters:

session - The session.

throwable - The exception.