Added setAttachment and getAttachment to WebSocket interface.

promatik · promatik · commit 2cb7f67f067f · 2017-11-30T15:39:56.000Z
This allows a WebSocket connection object to have any kind of data associated.
diff --git a/src/main/java/org/java_websocket/WebSocket.java b/src/main/java/org/java_websocket/WebSocket.java
@@ -220,4 +220,19 @@ enum READYSTATE {
 	 * @return Returns the decoded path component of this URI.
 	 **/
 	String getResourceDescriptor();
+
+	/**
+	 * Setter for an attachment on the socket connection.
+	 * The attachment may be of any type.
+	 * 
+	 * @param attachment The object to be attached to the user
+	 **/
+	<T> void setAttachment(T attachment);
+
+	/**
+	 * Getter for the connection attachment.
+	 * 
+	 * @return Returns the user attachment
+	 **/
+	<T> T getAttachment();
 }
diff --git a/src/main/java/org/java_websocket/WebSocketImpl.java b/src/main/java/org/java_websocket/WebSocketImpl.java
@@ -145,6 +145,11 @@ public class WebSocketImpl implements WebSocket {
 	 */
 	private PingFrame pingFrame;
 
+	/**
+	 * Attribute to store connection attachment
+	 */
+	private Object attachment;
+
 	/**
 	 * Creates a websocket with server role
 	 *
@@ -799,4 +804,15 @@ public WebSocketListener getWebSocketListener() {
 		return wsl;
 	}
 
+	@Override
+	@SuppressWarnings("unchecked")
+	public <T> T getAttachment() {
+		return (T) attachment;
+	}
+
+	@Override
+	public <T> void setAttachment(T attachment) {
+		this.attachment = attachment;
+	}
+
 }
