Package org.jivesoftware.openfire.websocket

Class WebSocketClientConnectionHandler

java.lang.Object

org.jivesoftware.openfire.websocket.WebSocketClientConnectionHandler

@WebSocket
public class WebSocketClientConnectionHandler
extends Object

This class handles all WebSocket events for the corresponding connection with a remote peer, analogous to the function of ClientConnectionHandler for TCP connections. Specifically the XMPP session is managed concurrently with the WebSocket session, including all framing and authentication requirements. Packets received from the remote peer are forwarded as needed via a SessionPacketRouter, and packets destined for the remote peer are forwarded via the corresponding RemoteEndpoint.

Field Summary

Fields

Modifier and Type	Field	Description
static SystemProperty<Boolean>	KEEP_ALIVE_FRAME_PING_ENABLED_PROPERTY
static SystemProperty<Duration>	KEEP_ALIVE_FRAME_PING_INTERVAL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebSocketClientConnectionHandler()

Method Summary

Modifier and Type	Method	Description
Duration	getMaxIdleTime()	Returns the max duration that a connection can be idle before being closed.
void	onClose(int statusCode, String reason)
void	onConnect(org.eclipse.jetty.websocket.api.Session session)
void	onError(Throwable error)
void	onTextMethod(String stanza)

Methods inherited from class java.lang.Object

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

Field Detail

KEEP_ALIVE_FRAME_PING_ENABLED_PROPERTY

public static final SystemProperty<Boolean> KEEP_ALIVE_FRAME_PING_ENABLED_PROPERTY

KEEP_ALIVE_FRAME_PING_INTERVAL_PROPERTY

public static final SystemProperty<Duration> KEEP_ALIVE_FRAME_PING_INTERVAL_PROPERTY

Constructor Detail

WebSocketClientConnectionHandler

public WebSocketClientConnectionHandler()

Method Detail

onConnect

@OnWebSocketConnect
public void onConnect(org.eclipse.jetty.websocket.api.Session session)

onClose

@OnWebSocketClose
public void onClose(int statusCode,
                    String reason)

onTextMethod

@OnWebSocketMessage
public void onTextMethod(String stanza)

onError

@OnWebSocketError
public void onError(Throwable error)

getMaxIdleTime

public Duration getMaxIdleTime()

Returns the max duration that a connection can be idle before being closed.

Returns:

the max duration that a connection can be idle.