Documented units for send-time limit and buffer-size limit

Issue: SPR-13753

Author: jhoeller

spring-websocket/src/main/java/org/springframework/web/socket/handler/ConcurrentWebSocketSessionDecorator.java

@@ -35,9 +35,9 @@
  * 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 flushLock 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.
+ * thread will fail to acquire the flush 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
@@ -69,6 +69,12 @@ public class ConcurrentWebSocketSessionDecorator extends WebSocketSessionDecorat
 	private final Lock closeLock = new ReentrantLock();
 
 
+	/**
+	 * Create a new {@code ConcurrentWebSocketSessionDecorator}.
+	 * @param delegate the {@code WebSocketSession} to delegate to
+	 * @param sendTimeLimit the send-time limit (milliseconds)
+	 * @param bufferSizeLimit the buffer-size limit (number of bytes)
+	 */
 	public ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit) {
 		super(delegate);
 		this.sendTimeLimit = sendTimeLimit;

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

@@ -52,22 +52,20 @@
 
 /**
  * An implementation of {@link WebSocketHandler} that delegates incoming WebSocket
- * messages to a {@link SubProtocolHandler} along with a {@link MessageChannel} to
- * which the sub-protocol handler can send messages from WebSocket clients to
- * the application.
- * <p>
- * Also an implementation of {@link MessageHandler} that finds the WebSocket
- * session associated with the {@link Message} and passes it, along with the message,
- * to the sub-protocol handler to send messages from the application back to the
- * client.
+ * messages to a {@link SubProtocolHandler} along with a {@link MessageChannel} to which
+ * the sub-protocol handler can send messages from WebSocket clients to the application.
+ *
+ * <p>Also an implementation of {@link MessageHandler} that finds the WebSocket session
+ * associated with the {@link Message} and passes it, along with the message, to the
+ * sub-protocol handler to send messages from the application back to the client.
  *
  * @author Rossen Stoyanchev
  * @author Andy Wilkinson
  * @author Artem Bilan
  * @since 4.0
  */
-public class SubProtocolWebSocketHandler implements WebSocketHandler,
-		SubProtocolCapable, MessageHandler, SmartLifecycle {
+public class SubProtocolWebSocketHandler
+		implements WebSocketHandler, SubProtocolCapable, MessageHandler, SmartLifecycle {
 
 	/**
 	 * Sessions connected to this handler use a sub-protocol. Hence we expect to
@@ -109,9 +107,14 @@ public class SubProtocolWebSocketHandler implements WebSocketHandler,
 	private volatile boolean running = false;
 
 
+	/**
+	 * Create a new {@code SubProtocolWebSocketHandler} for the given inbound and outbound channels.
+	 * @param clientInboundChannel the inbound {@code MessageChannel}
+	 * @param clientOutboundChannel the outbound {@code MessageChannel}
+	 */
 	public SubProtocolWebSocketHandler(MessageChannel clientInboundChannel, SubscribableChannel clientOutboundChannel) {
-		Assert.notNull(clientInboundChannel, "ClientInboundChannel must not be null");
-		Assert.notNull(clientOutboundChannel, "ClientOutboundChannel must not be null");
+		Assert.notNull(clientInboundChannel, "Inbound MessageChannel must not be null");
+		Assert.notNull(clientOutboundChannel, "Outbound MessageChannel must not be null");
 		this.clientInboundChannel = clientInboundChannel;
 		this.clientOutboundChannel = clientOutboundChannel;
 	}
@@ -125,7 +128,7 @@ public SubProtocolWebSocketHandler(MessageChannel clientInboundChannel, Subscrib
 	public void setProtocolHandlers(List<SubProtocolHandler> protocolHandlers) {
 		this.protocolHandlerLookup.clear();
 		this.protocolHandlers.clear();
-		for (SubProtocolHandler handler: protocolHandlers) {
+		for (SubProtocolHandler handler : protocolHandlers) {
 			addProtocolHandler(handler);
 		}
 	}
@@ -134,7 +137,6 @@ public List<SubProtocolHandler> getProtocolHandlers() {
 		return new ArrayList<SubProtocolHandler>(this.protocolHandlers);
 	}
 
-
 	/**
 	 * Register a sub-protocol handler.
 	 */
@@ -174,7 +176,7 @@ public void setDefaultProtocolHandler(SubProtocolHandler defaultProtocolHandler)
 	}
 
 	/**
-	 * @return the default sub-protocol handler to use
+	 * Return the default sub-protocol handler to use.
 	 */
 	public SubProtocolHandler getDefaultProtocolHandler() {
 		return this.defaultProtocolHandler;
@@ -187,23 +189,44 @@ public List<String> getSubProtocols() {
 		return new ArrayList<String>(this.protocolHandlerLookup.keySet());
 	}
 
-
+	/**
+	 * Specify the send-time limit (milliseconds).
+	 * @see ConcurrentWebSocketSessionDecorator
+	 */
 	public void setSendTimeLimit(int sendTimeLimit) {
 		this.sendTimeLimit = sendTimeLimit;
 	}
 
+	/**
+	 * Return the send-time limit (milliseconds).
+	 */
 	public int getSendTimeLimit() {
 		return this.sendTimeLimit;
 	}
 
+	/**
+	 * Specify the buffer-size limit (number of bytes).
+	 * @see ConcurrentWebSocketSessionDecorator
+	 */
 	public void setSendBufferSizeLimit(int sendBufferSizeLimit) {
 		this.sendBufferSizeLimit = sendBufferSizeLimit;
 	}
 
+	/**
+	 * Return the buffer-size limit (number of bytes).
+	 */
 	public int getSendBufferSizeLimit() {
-		return sendBufferSizeLimit;
+		return this.sendBufferSizeLimit;
+	}
+
+	/**
+	 * Return a String describing internal state and counters.
+	 */
+	public String getStatsInfo() {
+		return this.stats.toString();
 	}
 
+
 	@Override
 	public boolean isAutoStartup() {
 		return true;
@@ -221,14 +244,6 @@ public final boolean isRunning() {
 		}
 	}
 
-	/**
-	 * Return a String describing internal state and counters.
-	 */
-	public String getStatsInfo() {
-		return this.stats.toString();
-	}
-
-
 	@Override
 	public final void start() {
 		Assert.isTrue(this.defaultProtocolHandler != null || !this.protocolHandlers.isEmpty(), "No handlers");
@@ -262,6 +277,7 @@ public final void stop(Runnable callback) {
 		}
 	}
 
+
 	@Override
 	public void afterConnectionEstablished(WebSocketSession session) throws Exception {
 		// WebSocketHandlerDecorator could close the session