Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add concurrent WebSocket session decorator (temp commit)

Browse Source 
Issue: SPR-11586
This commit is contained in:
Rossen Stoyanchev
2014-03-20 16:37:59 -04:00
parent ac968e94ed
commit b7a974116e
6 changed files with 542 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
spring-websocket/src/main/java/org/springframework/web/socket/handler/ConcurrentWebSocketSessionDecorator.java Normal file
View File

@@ -0,0 +1,137 @@
/*
* Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket.handler;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
import java.io.IOException;
import java.util.Queue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
/**
* Wraps a {@link org.springframework.web.socket.WebSocketSession} and guarantees
* only one thread can send messages at a time.
*
* <p>If a send is slow, subsequent attempts to send more messages from a different
* thread will fail to acquire the lock and the messages will be buffered instead --
* at that time the specified buffer size limit and send time limit will be checked
* and the session closed if the limits are exceeded.
*
* @author Rossen Stoyanchev
* @since 4.0.3
*/
public class ConcurrentWebSocketSessionDecorator extends WebSocketSessionDecorator {
private static Log logger = LogFactory.getLog(ConcurrentWebSocketSessionDecorator.class);
private final int sendTimeLimit;
private final int bufferSizeLimit;
private final Queue<WebSocketMessage<?>> buffer = new LinkedBlockingQueue<WebSocketMessage<?>>();
private final AtomicInteger bufferSize = new AtomicInteger();
private volatile long sendStartTime;
private final Lock lock = new ReentrantLock();
public ConcurrentWebSocketSessionDecorator(
WebSocketSession delegateSession, int sendTimeLimit, int bufferSizeLimit) {
super(delegateSession);
this.sendTimeLimit = sendTimeLimit;
this.bufferSizeLimit = bufferSizeLimit;
}
public int getBufferSize() {
return this.bufferSize.get();
}
public long getInProgressSendTime() {
long start = this.sendStartTime;
return (start > 0 ? (System.currentTimeMillis() - start) : 0);
}
public void sendMessage(WebSocketMessage<?> message) throws IOException {
this.buffer.add(message);
this.bufferSize.addAndGet(message.getPayloadLength());
do {
if (!tryFlushMessageBuffer()) {
checkSessionLimits();
break;
}
}
while (!this.buffer.isEmpty());
}
private boolean tryFlushMessageBuffer() throws IOException {
if (this.lock.tryLock()) {
try {
while (true) {
WebSocketMessage<?> messageToSend = this.buffer.poll();
if (messageToSend == null) {
break;
}
this.bufferSize.addAndGet(messageToSend.getPayloadLength() * -1);
this.sendStartTime = System.currentTimeMillis();
getDelegate().sendMessage(messageToSend);
this.sendStartTime = 0;
}
}
finally {
this.sendStartTime = 0;
lock.unlock();
}
return true;
}
return false;
}
private void checkSessionLimits() throws IOException {
if (getInProgressSendTime() > this.sendTimeLimit) {
logError("A message could not be sent due to a timeout");
getDelegate().close();
}
else if (this.bufferSize.get() > this.bufferSizeLimit) {
logError("The total send buffer byte count '" + this.bufferSize.get() +
"' for session '" + getId() + "' exceeds the allowed limit '" + this.bufferSizeLimit + "'");
getDelegate().close();
}
}
private void logError(String reason) {
logger.error(reason + ", number of buffered messages is '" + this.buffer.size() +
"', time since the last send started is '" + getInProgressSendTime() + "' (ms)");
}
}

7
spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketHandlerDecorator.java
View File

@@ -23,6 +23,13 @@ import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
/**
* Wraps another {@link org.springframework.web.socket.WebSocketHandler}
* instance and delegates to it.
*
* <p>Also provides a {@link #getDelegate()} method to return the decorated
* handler as well as a {@link #getLastHandler()} method to go through all nested
* delegates and return the "last" handler.
*
* @author Rossen Stoyanchev
* @since 4.0
*/

137
spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketSessionDecorator.java Normal file
View File

@@ -0,0 +1,137 @@
/*
* Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket.handler;
import org.springframework.http.HttpHeaders;
import org.springframework.util.Assert;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketExtension;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.URI;
import java.security.Principal;
import java.util.List;
import java.util.Map;
/**
* Wraps another {@link org.springframework.web.socket.WebSocketSession} instance
* and delegates to it.
*
* <p>Also provides a {@link #getDelegate()} method to return the decorated session
* as well as a {@link #getLastSession()} method to go through all nested delegates
* and return the "last" session.
*
* @author Rossen Stoyanchev
* @since 4.0.3
*/
public class WebSocketSessionDecorator implements WebSocketSession {
private final WebSocketSession delegate;
public WebSocketSessionDecorator(WebSocketSession session) {
Assert.notNull(session, "Delegate WebSocketSessionSession is required");
this.delegate = session;
}
@Override
public String getId() {
return this.delegate.getId();
}
@Override
public URI getUri() {
return this.delegate.getUri();
}
@Override
public HttpHeaders getHandshakeHeaders() {
return this.delegate.getHandshakeHeaders();
}
@Override
public Map<String, Object> getAttributes() {
return this.delegate.getAttributes();
}
@Override
public Principal getPrincipal() {
return this.delegate.getPrincipal();
}
@Override
public InetSocketAddress getLocalAddress() {
return this.delegate.getLocalAddress();
}
@Override
public InetSocketAddress getRemoteAddress() {
return this.delegate.getRemoteAddress();
}
@Override
public String getAcceptedProtocol() {
return this.delegate.getAcceptedProtocol();
}
@Override
public List<WebSocketExtension> getExtensions() {
return this.delegate.getExtensions();
}
@Override
public boolean isOpen() {
return this.delegate.isOpen();
}
@Override
public void sendMessage(WebSocketMessage<?> message) throws IOException {
}
@Override
public void close() throws IOException {
this.delegate.close();
}
@Override
public void close(CloseStatus status) throws IOException {
this.delegate.close(status);
}
public WebSocketSession getDelegate() {
return this.delegate;
}
public WebSocketSession getLastSession() {
WebSocketSession result = this.delegate;
while (result instanceof WebSocketSessionDecorator) {
result = ((WebSocketSessionDecorator) result).getDelegate();
}
return result;
}
@Override
public String toString() {
return getClass().getSimpleName() + " [delegate=" + this.delegate + "]";
}
}

27
spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java
View File

@@ -42,6 +42,7 @@ import org.springframework.web.socket.SubProtocolCapable;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator;
/**
* An implementation of {@link WebSocketHandler} that delegates incoming WebSocket
@@ -74,6 +75,10 @@ public class SubProtocolWebSocketHandler
private final Map<String, WebSocketSession> sessions = new ConcurrentHashMap<String, WebSocketSession>();
private int sendTimeLimit = 20 * 1000;
private int sendBufferSizeLimit = 1024 * 1024;
private Object lifecycleMonitor = new Object();
private volatile boolean running = false;
@@ -155,6 +160,24 @@ public class SubProtocolWebSocketHandler
return new ArrayList<String>(this.protocolHandlers.keySet());
}
public void setSendTimeLimit(int sendTimeLimit) {
this.sendTimeLimit = sendTimeLimit;
}
public int getSendTimeLimit() {
return this.sendTimeLimit;
}
public void setSendBufferSizeLimit(int sendBufferSizeLimit) {
this.sendBufferSizeLimit = sendBufferSizeLimit;
}
public int getSendBufferSizeLimit() {
return sendBufferSizeLimit;
}
@Override
public boolean isAutoStartup() {
return true;
@@ -198,11 +221,15 @@ public class SubProtocolWebSocketHandler
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
session = new ConcurrentWebSocketSessionDecorator(session, getSendTimeLimit(), getSendBufferSizeLimit());
this.sessions.put(session.getId(), session);
if (logger.isDebugEnabled()) {
logger.debug("Started WebSocket session=" + session.getId() +
", number of sessions=" + this.sessions.size());
}
findProtocolHandler(session).afterSessionStarted(session, this.clientInboundChannel);
}