Package pl.morgwai.base.servlet.guiced.utils

Class PingingServletContextListener

java.lang.Object

pl.morgwai.base.servlet.scopes.GuiceServletContextListener

pl.morgwai.base.servlet.guiced.utils.PingingServletContextListener

All Implemented Interfaces:

ServletContextListener, EventListener

public abstract class PingingServletContextListener
extends GuiceServletContextListener

A GuiceServletContextListener that automatically registers and deregisters endpoints to a WebsocketPingerService. Endpoints need to be created with addEndpoint(Class, String) or annotated to use PingingEndpointConfigurator.

Field Summary

Fields inherited from class pl.morgwai.base.servlet.scopes.GuiceServletContextListener

endpointConfigurator, endpointContainer, log, servletContainer, servletModule

Constructor Summary

Constructors

Constructor	Description
PingingServletContextListener()

Method Summary

Modifier and Type	Method	Description
void	contextDestroyed(ServletContextEvent destructionEvent)	Stops the associated WebsocketPingerService.
protected GuiceServerEndpointConfigurator	createEndpointConfigurator()	Overrides default configurator used by GuiceServletContextListener.addEndpoint(Class, String) to be a PingingEndpointConfigurator.
protected int	getPingFailureLimit()	Allows subclasses to override ping failure limit.
protected int	getPingIntervalSeconds()	Allows subclasses to override ping interval.
protected int	getPingSize()	Allows subclasses to override ping data size.
protected boolean	isPingerInKeepAliveOnlyMode()	Allows subclasses to override pinger mode.
protected boolean	shouldSynchronizePingSending()	Allows subclasses to override synchronizeSending flag.

Methods inherited from class pl.morgwai.base.servlet.scopes.GuiceServletContextListener

addEndpoint, addEndpoint, addFilter, addFilter, addFilter, addServlet, configureInjections, configureServletsFiltersEndpoints, contextInitialized, createInjector, getExecutorsShutdownTimeoutSeconds, getInjector, handleUncleanExecutorTerminations

Methods inherited from class java.lang.Object

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

Constructor Detail

PingingServletContextListener

public PingingServletContextListener()

Method Detail

isPingerInKeepAliveOnlyMode

protected boolean isPingerInKeepAliveOnlyMode()

Allows subclasses to override pinger mode. By default false.

getPingIntervalSeconds

protected int getPingIntervalSeconds()

Allows subclasses to override ping interval. By default WebsocketPingerService.DEFAULT_INTERVAL.

getPingFailureLimit

protected int getPingFailureLimit()

Allows subclasses to override ping failure limit. By default WebsocketPingerService.DEFAULT_FAILURE_LIMIT.

getPingSize

protected int getPingSize()

Allows subclasses to override ping data size. By default WebsocketPingerService.DEFAULT_PING_SIZE.

shouldSynchronizePingSending

protected boolean shouldSynchronizePingSending()

Allows subclasses to override synchronizeSending flag. By default false.

createEndpointConfigurator

protected GuiceServerEndpointConfigurator createEndpointConfigurator()

Overrides default configurator used by GuiceServletContextListener.addEndpoint(Class, String) to be a PingingEndpointConfigurator.

Overrides:

createEndpointConfigurator in class GuiceServletContextListener

contextDestroyed

public void contextDestroyed(ServletContextEvent destructionEvent)

Stops the associated WebsocketPingerService.

Specified by:

contextDestroyed in interface ServletContextListener

Overrides:

contextDestroyed in class GuiceServletContextListener