javax.net.websocket

Class Endpoint

java.lang.Object

javax.net.websocket.Endpoint

Direct Known Subclasses:

EndpointAdapter, org.glassfish.tyrus.spi.SPIEndpoint

public abstract class Endpoint
extends Object

The Web Socket Endpoint represents and object that can handle web socket conversations. If deployed as a server, that is to say, the endpoint is registered to a URL, the endpoint may handle one or more web socket conversations, one for each client that establishes a connection. If deployed as a client, the endpoint will participate in only one conversation: that with the server to which it connects. If the endpoint is a server which will cater to multiple clients, the endpoint may be called by multiple threads, no more than one per client, at any one time. This means that when implementing/overriding the methods of Endpoint, the developer should be aware that any state management must be carefully synchronized with this in mine.

Since:

DRAFT 001

Author:

dannycoward

Constructor Summary

Constructors

Constructor and Description
Endpoint()

Method Summary

Methods

Modifier and Type	Method and Description
void	onClose(Session session, CloseReason closeReason) Developers may implement this method to be notified when an active conversation has just been terminated.
void	onError(Throwable thr, Session s) Developers may implement this method when a web socket connection, represented by the session, creates some kind of error that is not modeled in the web socket protocol.
abstract void	onOpen(Session session) Developers may implement this method to be notified when a new conversation has just begun.

Methods inherited from class java.lang.Object

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

Constructor Detail

Endpoint

public Endpoint()

Method Detail

onOpen

public abstract void onOpen(Session session)

Developers may implement this method to be notified when a new conversation has just begun.

Parameters:

session -

onClose

public void onClose(Session session,
           CloseReason closeReason)

Developers may implement this method to be notified when an active conversation has just been terminated.

Parameters:

session -

onError

public void onError(Throwable thr,
           Session s)

Developers may implement this method when a web socket connection, represented by the session, creates some kind of error that is not modeled in the web socket protocol. This may for example be a notification that an incoming message is too big to handle, or that the incoming message could not be encoded.

There are a number of categories of exception that this method is (currently) defined to handle:-
- connection problems, for example, a socket failure that occurs before the web socket connection can be formally closed.
- errors thrown by developer create message handlers calls.
- conversion errors encoding incoming messages before any message handler has been called.
TBD We may come up with less of a 'catch-all' mechanism for handling exceptions, especially given the varying nature of these categories of exception.