org.java_websocket.AbstractWebSocket Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2018 Nathan Rajlich
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
package org.java_websocket;
import org.java_websocket.framing.CloseFrame;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Timer;
import java.util.TimerTask;
/**
* Base class for additional implementations for the server as well as the client
*/
public abstract class AbstractWebSocket extends WebSocketAdapter
{
/**
* Attribute which allows you to deactivate the Nagle's algorithm
*
* @since 1.3.3
*/
private boolean tcpNoDelay;
/**
* Attribute which allows you to enable/disable the SO_REUSEADDR socket option.
*
* @since 1.3.5
*/
private boolean reuseAddr;
/**
* Attribute for a timer allowing to check for lost connections
*
* @since 1.3.4
*/
private Timer connectionLostTimer;
/**
* Attribute for a timertask allowing to check for lost connections
*
* @since 1.3.4
*/
private TimerTask connectionLostTimerTask;
/**
* Attribute for the lost connection check interval
*
* @since 1.3.4
*/
private int connectionLostTimeout = 60;
private int pingTime=connectionLostTimeout/2;
/**
* Attribute to keep track if the WebSocket Server/Client is running/connected
*
* @since 1.3.9
*/
private boolean websocketRunning = false;
private boolean enablePing = true;
/**
* Get the interval checking for lost connections
* Default is 60 seconds
*
* @return the interval
* @since 1.3.4
*/
public int getConnectionLostTimeout()
{
return connectionLostTimeout;
}
/**
* Setter for the interval checking for lost connections
* A value lower or equal 0 results in the check to be deactivated
*
* @param connectionLostTimeout the interval in seconds
* @since 1.3.4
*/
public void setConnectionLostTimeout(int connectionLostTimeout)
{
this.connectionLostTimeout = connectionLostTimeout;
onTimeoutChange();
}
public int getPingTime()
{
return pingTime;
}
public void setPingTime(int pingTime)
{
this.pingTime = pingTime;
onTimeoutChange();
}
private void onTimeoutChange()
{
if (this.connectionLostTimeout <= 0)
{
if (WebSocketImpl.DEBUG)
System.out.println("Connection lost timer stopped");
cancelConnectionLostTimer();
return;
}
if (this.websocketRunning)
{
if (WebSocketImpl.DEBUG)
System.out.println("Connection lost timer restarted");
//Reset all the pings
try
{
ArrayList connections = new ArrayList(getConnections());
WebSocketImpl webSocketImpl;
for (WebSocket conn : connections)
{
if (conn instanceof WebSocketImpl)
{
webSocketImpl = (WebSocketImpl) conn;
webSocketImpl.updateLastPong();
}
}
} catch (Exception e)
{
if (WebSocketImpl.DEBUG)
System.out.println("Exception during connection lost restart: " + e.getMessage());
}
restartConnectionLostTimer();
}
}
/**
* 是否开启ping，默认为true。ping的时间间隔见{@linkplain #setPingTime(int)}
*
* @return
*/
public boolean isEnablePing()
{
return enablePing;
}
/**
* 设置是否开启ping。
*
* @param enablePing
*/
public void setEnablePing(boolean enablePing)
{
this.enablePing = enablePing;
}
/**
* Stop the connection lost timer
*
* @since 1.3.4
*/
protected void stopConnectionLostTimer()
{
if (connectionLostTimer != null || connectionLostTimerTask != null)
{
this.websocketRunning = false;
if (WebSocketImpl.DEBUG)
System.out.println("Connection lost timer stopped");
cancelConnectionLostTimer();
}
}
/**
* Start the connection lost timer
*
* @since 1.3.4
*/
protected void startConnectionLostTimer()
{
if (this.connectionLostTimeout <= 0)
{
if (WebSocketImpl.DEBUG)
System.out.println("Connection lost timer deactivated");
return;
}
if (WebSocketImpl.DEBUG)
System.out.println("Connection lost timer started");
this.websocketRunning = true;
restartConnectionLostTimer();
}
/**
* This methods allows the reset of the connection lost timer in case of a changed parameter
*
* @since 1.3.4
*/
private void restartConnectionLostTimer()
{
cancelConnectionLostTimer();
if(!enablePing){
return;
}
connectionLostTimer = new Timer("WebSocketTimer");
connectionLostTimerTask = new TimerTask()
{
/**
* Keep the connections in a separate list to not cause deadlocks
*/
private ArrayList connections = new ArrayList();
@Override
public void run()
{
connections.clear();
try
{
connections.addAll(getConnections());
long current = (System.currentTimeMillis() - (connectionLostTimeout * 1000));
WebSocketImpl webSocketImpl;
for (WebSocket conn : connections)
{
if (conn instanceof WebSocketImpl)
{
webSocketImpl = (WebSocketImpl) conn;
if (webSocketImpl.getLastPong() < current)
{
if (WebSocketImpl.DEBUG)
System.out
.println("Closing connection due to no pong received: " + conn.toString());
webSocketImpl.closeConnection(CloseFrame.ABNORMAL_CLOSE,
"The connection was closed because the other endpoint did not respond with a " +
"pong in time. For more information check: https://github" +
".com/TooTallNate/Java-WebSocket/wiki/Lost-connection-detection");
} else
{
if (webSocketImpl.isOpen())
{
webSocketImpl.sendPing();
} else
{
if (WebSocketImpl.DEBUG)
System.out.println("Trying to ping a non open connection: " + conn.toString());
}
}
}
}
} catch (Exception e)
{
if (WebSocketImpl.DEBUG)
System.out.println("Exception during connection lost ping: " + e.getMessage());
}
connections.clear();
}
};
connectionLostTimer.scheduleAtFixedRate(connectionLostTimerTask, pingTime * 1000,
pingTime * 1000);
}
/**
* Getter to get all the currently available connections
*
* @return the currently available connections
* @since 1.3.4
*/
protected abstract Collection getConnections();
/**
* Cancel any running timer for the connection lost detection
*
* @since 1.3.4
*/
private void cancelConnectionLostTimer()
{
if (connectionLostTimer != null)
{
connectionLostTimer.cancel();
connectionLostTimer = null;
}
if (connectionLostTimerTask != null)
{
connectionLostTimerTask.cancel();
connectionLostTimerTask = null;
}
}
/**
* Tests if TCP_NODELAY is enabled.
*
* @return a boolean indicating whether or not TCP_NODELAY is enabled for new connections.
* @since 1.3.3
*/
public boolean isTcpNoDelay()
{
return tcpNoDelay;
}
/**
* Setter for tcpNoDelay
*
* Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm) for new connections
*
* @param tcpNoDelay true to enable TCP_NODELAY, false to disable.
* @since 1.3.3
*/
public void setTcpNoDelay(boolean tcpNoDelay)
{
this.tcpNoDelay = tcpNoDelay;
}
/**
* Tests Tests if SO_REUSEADDR is enabled.
*
* @return a boolean indicating whether or not SO_REUSEADDR is enabled.
* @since 1.3.5
*/
public boolean isReuseAddr()
{
return reuseAddr;
}
/**
* Setter for soReuseAddr
*
* Enable/disable SO_REUSEADDR for the socket
*
* @param reuseAddr whether to enable or disable SO_REUSEADDR
* @since 1.3.5
*/
public void setReuseAddr(boolean reuseAddr)
{
this.reuseAddr = reuseAddr;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy