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

Class SimplePingingEndpointServletContextListener

java.lang.Object

pl.morgwai.base.servlet.scopes.GuiceServletContextListener

pl.morgwai.base.servlet.guiced.utils.SimplePingingEndpointServletContextListener

All Implemented Interfaces:

EventListener, ServletContextListener

@Deprecated(since="4.1",
            forRemoval=true)
public abstract class SimplePingingEndpointServletContextListener
extends GuiceServletContextListener

Deprecated, for removal: This API element is subject to removal in a future version.

use PingingServletContextListener instead.

A GuiceServletContextListener that automatically register/deregister endpoint instances to a WebsocketPingerService. Endpoints need to be created with addEndpoint(Class, String) or annotated to use SimplePingingEndpointServletContextListener.SimplePingingEndpointConfigurator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SimplePingingEndpointServletContextListener.SimplePingingEndpointConfigurator	Deprecated, for removal: This API element is subject to removal in a future version. Automatically registers and deregisters created endpoints to the WebsocketPingerService of the SimplePingingEndpointServletContextListener.

Field Summary

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

log, servletContainer, servletModule, websocketContainer

Constructor Summary

Constructors

Constructor	Description
SimplePingingEndpointServletContextListener()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected void	addEndpoint(Class<?> endpointClass, String path)	Deprecated, for removal: This API element is subject to removal in a future version. Adds an endpoint using a SimplePingingEndpointServletContextListener.SimplePingingEndpointConfigurator.
void	contextDestroyed(ServletContextEvent destructionEvent)	Deprecated, for removal: This API element is subject to removal in a future version. Stops the associated WebsocketPingerService.
protected int	getMaxMalformedPongCount()	Deprecated, for removal: This API element is subject to removal in a future version. Allows subclasses to override maximum allowed malformed pongs.
protected int	getPingIntervalSeconds()	Deprecated, for removal: This API element is subject to removal in a future version. Allows subclasses to override ping interval.

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

addEndpoint, addFilter, addServlet, configureInjections, configureServletsFiltersEndpoints, contextInitialized, getInjector, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePingingEndpointServletContextListener

public SimplePingingEndpointServletContextListener()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

getPingIntervalSeconds

protected int getPingIntervalSeconds()

Deprecated, for removal: This API element is subject to removal in a future version.

Allows subclasses to override ping interval.

getMaxMalformedPongCount

protected int getMaxMalformedPongCount()

Deprecated, for removal: This API element is subject to removal in a future version.

Allows subclasses to override maximum allowed malformed pongs.

contextDestroyed

public void contextDestroyed(ServletContextEvent destructionEvent)

Deprecated, for removal: This API element is subject to removal in a future version.

Stops the associated WebsocketPingerService.

addEndpoint

protected void addEndpoint(Class<?> endpointClass,
                           String path)
                    throws ServletException

Deprecated, for removal: This API element is subject to removal in a future version.

Adds an endpoint using a SimplePingingEndpointServletContextListener.SimplePingingEndpointConfigurator.

Overrides:

addEndpoint in class GuiceServletContextListener

Throws:

ServletException