Package org.basex.http.ws

Class WebSocket

java.lang.Object

org.eclipse.jetty.websocket.api.WebSocketAdapter

org.basex.http.ws.WebSocket

All Implemented Interfaces:

ClientInfo, org.eclipse.jetty.websocket.api.WebSocketConnectionListener, org.eclipse.jetty.websocket.api.WebSocketListener

public final class WebSocket
extends org.eclipse.jetty.websocket.api.WebSocketAdapter
implements ClientInfo

This class defines an abstract WebSocket. It inherits the Jetty WebSocket adapter.

Author:

BaseX Team 2005-23, BSD License, Johannes Finckh

Field Summary

Fields

Modifier and Type	Field	Description
ConcurrentHashMap<String,Value>	atts	WebSocket attributes.
Context	context	Database context.
String	id	Client WebSocket id.
WsPath	path	Path.
javax.servlet.http.HttpSession	session	HTTP Session.

Method Summary

Modifier and Type	Method	Description
String	clientAddress()
String	clientName()
void	close()	Closes the WebSocket connection.
void	error(Exception ex)	Sends an error to the client.
void	onWebSocketBinary(byte[] payload, int offset, int len)
void	onWebSocketClose(int status, String message)
void	onWebSocketConnect(org.eclipse.jetty.websocket.api.Session sess)
void	onWebSocketError(Throwable cause)
void	onWebSocketText(String message)

Methods inherited from class org.eclipse.jetty.websocket.api.WebSocketAdapter

getRemote, getSession, isConnected, isNotConnected

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.basex.server.ClientInfo

clientName

Field Detail

atts

public final ConcurrentHashMap<String,Value> atts

WebSocket attributes.

context

public final Context context

Database context.

path

public final WsPath path

Path.

id

public String id

Client WebSocket id.

session

public javax.servlet.http.HttpSession session

HTTP Session.

Method Detail

onWebSocketConnect

public void onWebSocketConnect(org.eclipse.jetty.websocket.api.Session sess)

Specified by:

onWebSocketConnect in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener

Overrides:

onWebSocketConnect in class org.eclipse.jetty.websocket.api.WebSocketAdapter

onWebSocketError

public void onWebSocketError(Throwable cause)

Specified by:

onWebSocketError in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener

Overrides:

onWebSocketError in class org.eclipse.jetty.websocket.api.WebSocketAdapter

onWebSocketClose

public void onWebSocketClose(int status,
                             String message)

Specified by:

onWebSocketClose in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener

Overrides:

onWebSocketClose in class org.eclipse.jetty.websocket.api.WebSocketAdapter

onWebSocketText

public void onWebSocketText(String message)

Specified by:

onWebSocketText in interface org.eclipse.jetty.websocket.api.WebSocketListener

Overrides:

onWebSocketText in class org.eclipse.jetty.websocket.api.WebSocketAdapter

onWebSocketBinary

public void onWebSocketBinary(byte[] payload,
                              int offset,
                              int len)

Specified by:

onWebSocketBinary in interface org.eclipse.jetty.websocket.api.WebSocketListener

Overrides:

onWebSocketBinary in class org.eclipse.jetty.websocket.api.WebSocketAdapter

clientAddress

public String clientAddress()

Specified by:

clientAddress in interface ClientInfo

clientName

public String clientName()

Specified by:

clientName in interface ClientInfo

close

public void close()

Closes the WebSocket connection.

error

public void error(Exception ex)

Sends an error to the client.

Parameters:

ex - exception