Adding clear method getConnections

marci4 · marci4 · commit b13c890c4843 · 2018-02-13T21:18:51.000+01:00
diff --git a/src/main/java/org/java_websocket/AbstractWebSocket.java b/src/main/java/org/java_websocket/AbstractWebSocket.java
@@ -138,7 +138,7 @@ private void restartConnectionLostTimer() {
 			@Override
 			public void run() {
 				connections.clear();
-				connections.addAll( connections() );
+				connections.addAll( getConnections() );
 				long current = (System.currentTimeMillis()-(connectionLostTimeout * 1500));
 				WebSocketImpl webSocketImpl;
 				for( WebSocket conn : connections ) {
@@ -169,7 +169,7 @@ public void run() {
      * @return the currently available connections
 	 * @since 1.3.4
      */
-    protected abstract Collection<WebSocket> connections();
+    protected abstract Collection<WebSocket> getConnections();
 
     /**
      * Cancel any running timer for the connection lost detection
diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java
@@ -329,7 +329,7 @@ public <T> void setAttachment(T attachment) {
 	}
 
 	@Override
-	protected Collection<WebSocket> connections() {
+	protected Collection<WebSocket> getConnections() {
 		return Collections.singletonList((WebSocket ) engine );
 	}
 
diff --git a/src/main/java/org/java_websocket/server/WebSocketServer.java b/src/main/java/org/java_websocket/server/WebSocketServer.java
@@ -264,14 +264,29 @@ public void stop() throws IOException , InterruptedException {
 	}
 
 	/**
+	 * PLEASE use the method getConnections() in the future!
+	 *
 	 * Returns a WebSocket[] of currently connected clients.
 	 * Its iterators will be failfast and its not judicious
 	 * to modify it.
 	 * 
 	 * @return The currently connected clients.
+	 *
 	 */
+	@Deprecated
 	public Collection<WebSocket> connections() {
-		return this.connections;
+		return getConnections();
+	}
+
+	/**
+	 * Returns  all currently connected clients.
+	 * This collection does not allow any modification e.g. removing a client.
+	 *
+	 * @return A unmodifiable collection of all currently connected clients
+	 * @since 1.3.8
+	 */
+	public Collection<WebSocket> getConnections() {
+		return Collections.unmodifiableCollection( new ArrayList<WebSocket>(connections) );
 	}
 
 	public InetSocketAddress getAddress() {

Original file line number	Diff line number	Diff line change
`@@ -329,7 +329,7 @@ public <T> void setAttachment(T attachment) {`
`329`	`329`	`}`
`330`	`330`
`331`	`331`	`@Override`
`332`		`- protected Collection<WebSocket> connections() {`
	`332`	`+ protected Collection<WebSocket> getConnections() {`
`333`	`333`	`return Collections.singletonList((WebSocket ) engine );`
`334`	`334`	`}`
`335`	`335`