org.snf4j.websocket

Class AbstractWebSocketHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractStreamHandler

org.snf4j.websocket.AbstractWebSocketHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader, IWebSocketHandler

Direct Known Subclasses:

WebSocketClientHandler, WebSocketServerHandler

public abstract class AbstractWebSocketHandler
extends AbstractStreamHandler
implements IWebSocketHandler

Base implementation of the IWebSocketHandler interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebSocketHandler() Constructs an unnamed Web Socket handler for server sessions with the default configuration.
protected	AbstractWebSocketHandler(IWebSocketSessionConfig config) Constructs an unnamed Web Socket handler with the specified configuration.
protected	AbstractWebSocketHandler(String name) Constructs a named Web Socket handler for server sessions with the default configuration.
protected	AbstractWebSocketHandler(String name, IWebSocketSessionConfig config) Constructs a named Web Socket handler with the specified configuration.
protected	AbstractWebSocketHandler(String name, URI requestUri) Constructs a named Web Socket handler for client sessions with the default configuration.
protected	AbstractWebSocketHandler(URI requestUri) Constructs an unnamed Web Socket handler for client sessions with the default configuration.

Method Summary

Modifier and Type	Method and Description
IWebSocketSessionConfig	getConfig() Returns the Web Socket configuration object that will be used to configure the behavior of the associated session.

Methods inherited from class org.snf4j.core.handler.AbstractStreamHandler

available, available, getSession, setSession

Methods inherited from class org.snf4j.core.handler.AbstractHandler

event, event, exception, getFactory, getName, incident, read, read, timer, timer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.handler.IStreamHandler

getSession, setSession

Methods inherited from interface org.snf4j.core.handler.IHandler

event, event, exception, getFactory, getName, incident, read, read, read, timer, timer

Methods inherited from interface org.snf4j.core.IStreamReader

available, available, read, read

Constructor Detail

AbstractWebSocketHandler

protected AbstractWebSocketHandler()

Constructs an unnamed Web Socket handler for server sessions with the default configuration.

See Also:

DefaultWebSocketSessionConfig

AbstractWebSocketHandler

protected AbstractWebSocketHandler(URI requestUri)

Constructs an unnamed Web Socket handler for client sessions with the default configuration.

Parameters:

requestUri - request URI that will be used to set the Host header field and the "Request-URI" of the GET method

See Also:

DefaultWebSocketSessionConfig

AbstractWebSocketHandler

protected AbstractWebSocketHandler(String name)

Constructs a named Web Socket handler for server sessions with the default configuration.

Parameters:

name - the name for this handler

See Also:

DefaultWebSocketSessionConfig

AbstractWebSocketHandler

protected AbstractWebSocketHandler(String name,
                                   URI requestUri)

Constructs a named Web Socket handler for client sessions with the default configuration.

Parameters:

name - the name for this handler

requestUri - request URI that will be used to set the Host header field and the "Request-URI" of the GET method

See Also:

DefaultWebSocketSessionConfig

AbstractWebSocketHandler

protected AbstractWebSocketHandler(IWebSocketSessionConfig config)

Constructs an unnamed Web Socket handler with the specified configuration.

Parameters:

config - the Web Socket session configuration

AbstractWebSocketHandler

protected AbstractWebSocketHandler(String name,
                                   IWebSocketSessionConfig config)

Constructs a named Web Socket handler with the specified configuration.

Parameters:

name - the name for this handler

config - the Web Socket session configuration

Method Detail

getConfig

public IWebSocketSessionConfig getConfig()

Returns the Web Socket configuration object that will be used to configure the behavior of the associated session.

Specified by:

getConfig in interface IHandler

Specified by:

getConfig in interface IWebSocketHandler

Overrides:

getConfig in class AbstractHandler

Returns:

the Web Socket configuration object

See Also:

ISessionConfig