Adding userData to GCDAsyncSocket so that arbitrary information may be associated with the socket.

robbiehanson · robbiehanson · commit bd1bc68403a3 · 2011-02-21T19:02:39.000Z
diff --git a/GCD/GCDAsyncSocket.h b/GCD/GCDAsyncSocket.h
@@ -84,6 +84,8 @@ typedef enum GCDAsyncSocketError GCDAsyncSocketError;
 	NSMutableData *sslReadBuffer;
 	size_t sslWriteCachedLength;
 #endif
+	
+	id userData;
 }
 
 /**
@@ -170,6 +172,13 @@ typedef enum GCDAsyncSocketError GCDAsyncSocketError;
 - (BOOL)isIPv4PreferredOverIPv6;
 - (void)setPreferIPv4OverIPv6:(BOOL)flag;
 
+/**
+ * User data allows you to associate arbitrary information with the socket.
+ * This data is not used internally by socket in any way.
+**/
+- (id)userData;
+- (void)setUserData:(id)arbitraryUserData;
+
 #pragma mark Accepting
 
 /**
diff --git a/GCD/GCDAsyncSocket.m b/GCD/GCDAsyncSocket.m
@@ -1182,6 +1182,35 @@ - (void)setPreferIPv4OverIPv6:(BOOL)flag
 	}
 }
 
+- (id)userData
+{
+	__block id result;
+	
+	dispatch_block_t block = ^{
+		
+		result = [userData retain];
+	};
+	
+	if (dispatch_get_current_queue() == socketQueue)
+		block();
+	else
+		dispatch_sync(socketQueue, block);
+	
+	return [result autorelease];
+}
+
+- (void)setUserData:(id)arbitraryUserData
+{
+	dispatch_async(socketQueue, ^{
+		
+		if (userData != arbitraryUserData)
+		{
+			[userData release];
+			userData = [arbitraryUserData retain];
+		}
+	});
+}
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 #pragma mark Accepting
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
