Use magic to narrow the NSURLConnection performance gap to almost nothing :)

@@ -21,7 +21,7 @@
 #import "ASIInputStream.h"
 #import "ASIInputStream.h"
 
 
 // Automatically set on build
 // Automatically set on build
-NSString *ASIHTTPRequestVersion = @"v1.2-53 2009-12-19";
+NSString *ASIHTTPRequestVersion = @"v1.2-54 2009-12-19";
 
 
 NSString* const NetworkRequestErrorDomain = @"ASIHTTPRequestErrorDomain";
 NSString* const NetworkRequestErrorDomain = @"ASIHTTPRequestErrorDomain";
 
 
@@ -56,6 +56,10 @@ static NSError *ASITooMuchRedirectionError;
 static NSMutableArray *bandwidthUsageTracker = nil;
 static NSMutableArray *bandwidthUsageTracker = nil;
 static unsigned long averageBandwidthUsedPerSecond = 0;
 static unsigned long averageBandwidthUsedPerSecond = 0;
 
 
+// These are used for queuing persistent connections on the same connection
+static unsigned char streamNumber = 0;
+static void *streamIDs[4];
+
 // Records how much bandwidth all requests combined have used in the last second
 // Records how much bandwidth all requests combined have used in the last second
 static unsigned long bandwidthUsedInLastSecond = 0; 
 static unsigned long bandwidthUsedInLastSecond = 0; 
 
 
@@ -116,6 +120,8 @@ static BOOL isiPhoneOS2;
 // Start the read stream. Called by loadRequest, and again to restart the request when authentication is needed
 // Start the read stream. Called by loadRequest, and again to restart the request when authentication is needed
 - (void)startRequest;
 - (void)startRequest;
 
 
+- (void)markAsFinished;
+
 #if TARGET_OS_IPHONE
 #if TARGET_OS_IPHONE
 + (void)registerForNetworkReachabilityNotifications;
 + (void)registerForNetworkReachabilityNotifications;
 + (void)unsubscribeFromNetworkReachabilityNotifications;
 + (void)unsubscribeFromNetworkReachabilityNotifications;
@@ -177,6 +183,11 @@ static BOOL isiPhoneOS2;
 		ASIUnableToCreateRequestError = [[NSError errorWithDomain:NetworkRequestErrorDomain code:ASIUnableToCreateRequestErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:@"Unable to create request (bad url?)",NSLocalizedDescriptionKey,nil]] retain];
 		ASIUnableToCreateRequestError = [[NSError errorWithDomain:NetworkRequestErrorDomain code:ASIUnableToCreateRequestErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:@"Unable to create request (bad url?)",NSLocalizedDescriptionKey,nil]] retain];
 		ASITooMuchRedirectionError = [[NSError errorWithDomain:NetworkRequestErrorDomain code:ASITooMuchRedirectionErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:@"The request failed because it redirected too many times",NSLocalizedDescriptionKey,nil]] retain];	
 		ASITooMuchRedirectionError = [[NSError errorWithDomain:NetworkRequestErrorDomain code:ASITooMuchRedirectionErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:@"The request failed because it redirected too many times",NSLocalizedDescriptionKey,nil]] retain];	
 
 
+		// IDs that will be used for the four streams we'll create (see 
+		char i;
+		for (i=0; i<4; i++) {
+			streamIDs[i] = (void *)CFNumberCreate(kCFAllocatorDefault, kCFNumberCharType, &i);	
+		}
 #if TARGET_OS_IPHONE
 #if TARGET_OS_IPHONE
 		isiPhoneOS2 = ((floorf([[[UIDevice currentDevice] systemVersion] floatValue]) == 2.0) ? YES : NO);
 		isiPhoneOS2 = ((floorf([[[UIDevice currentDevice] systemVersion] floatValue]) == 2.0) ? YES : NO);
 #else
 #else
@@ -502,7 +513,11 @@ static BOOL isiPhoneOS2;
 		
 		
 	// On Leopard, we'll create the thread ourselves
 	// On Leopard, we'll create the thread ourselves
 	} else {
 	} else {
+		if ([self shouldRunInBackgroundThread]) {
 			[self performSelectorInBackground:@selector(startAsynchronous) withObject:nil];	
 			[self performSelectorInBackground:@selector(startAsynchronous) withObject:nil];	
+		} else {
+			[self startAsynchronous];	
+		}
 	}
 	}
 #endif
 #endif
 }
 }
@@ -811,8 +826,23 @@ static BOOL isiPhoneOS2;
 	}
 	}
 	
 	
 	// Use a persistent connection if possible
 	// Use a persistent connection if possible
+	if (shouldAttemptPersistentConnection) {
 		CFReadStreamSetProperty(readStream,  kCFStreamPropertyHTTPAttemptPersistentConnection, kCFBooleanTrue);
 		CFReadStreamSetProperty(readStream,  kCFStreamPropertyHTTPAttemptPersistentConnection, kCFBooleanTrue);
 		
 		
+		// Based on http://lists.apple.com/archives/macnetworkprog/2008/Dec/msg00001.html
+		// Basically, we aim to open a maximum of 4 connections (each one with a different id), and then subsequent requests will try to re-use the same stream, assuming we're connecting to the same server
+		// I'm guessing this will perform less well when you're connecting to several different servers at once
+		// But if you aren't, this appears to be the magic bullet for matching NSURLConnection's performance
+		
+		// We will re-use the previous ID for a synchronous request, since that probably gives us a greater chance of maximimising connection re-use
+		if (![self isSynchronous]) {
+			streamNumber++;
+			if (streamNumber == 4) {
+				streamNumber = 0;
+			}
+		}
+		CFReadStreamSetProperty(readStream, CFSTR("ASIStreamID"), streamIDs[streamNumber]);
+	}
 	
 	
 	// Handle proxy settings
 	// Handle proxy settings
 
 
@@ -889,6 +919,7 @@ static BOOL isiPhoneOS2;
 		return;
 		return;
 	}
 	}
 
 
+	
 	[[self cancelledLock] unlock];
 	[[self cancelledLock] unlock];
 	
 	
 	if (shouldResetProgressIndicators) {
 	if (shouldResetProgressIndicators) {
@@ -919,14 +950,14 @@ static BOOL isiPhoneOS2;
 	
 	
 	[NSTimer scheduledTimerWithTimeInterval:0.25 target:self selector:@selector(updateStatus:) userInfo:nil repeats:YES];
 	[NSTimer scheduledTimerWithTimeInterval:0.25 target:self selector:@selector(updateStatus:) userInfo:nil repeats:YES];
 
 
-	// If we're running asynchronously on the main thread, the runloop will already be running
+	// If we're running asynchronously on the main thread, the runloop will already be running and we can return control
 	if (![NSThread isMainThread]) {
 	if (![NSThread isMainThread]) {
-		// Will stop automatically when the request is done
+		while (!complete) {
 			CFRunLoopRun();
 			CFRunLoopRun();
 		}
 		}
+	}
 }
 }
 
 
-
 // This is the main loop for synchronous requests.
 // This is the main loop for synchronous requests.
 - (void)loadSynchronous
 - (void)loadSynchronous
 {
 {
@@ -935,31 +966,22 @@ static BOOL isiPhoneOS2;
 		[self scheduleReadStream];		
 		[self scheduleReadStream];		
 	}
 	}
 	
 	
-//	if ([NSThread isMainThread]) {
-//		[NSTimer scheduledTimerWithTimeInterval:0.25 target:self selector:@selector(updateStatus:) userInfo:nil repeats:YES];
-//		CFRunLoopRunInMode(kCFRunLoopDefaultMode, timeOutSeconds, NO);
-//
-//	} else if (!uploadProgressDelegate && !downloadProgressDelegate) {
-//		CFRunLoopRunInMode(kCFRunLoopDefaultMode, timeOutSeconds, NO);
-//		[self checkRequestStatus];
-//	} else {
-	
+	// If we don't need to track progress or throttle bandwidth, we won't bother to check up the status of the request (faster)
+	if (downloadProgressDelegate || uploadProgressDelegate || queue || [[self class] isBandwidthThrottled]) {
+		[NSTimer scheduledTimerWithTimeInterval:0.25 target:self selector:@selector(updateStatus:) userInfo:nil repeats:YES];
+	}
 	while (!complete) {
 	while (!complete) {
-			[self checkRequestStatus];
-			CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.25, NO);
+		CFRunLoopRun();
 	}
 	}
-	//}
+
 }
 }
 
 
 // This gets fired every 1/4 of a second in asynchronous requests to update the progress and work out if we need to timeout
 // This gets fired every 1/4 of a second in asynchronous requests to update the progress and work out if we need to timeout
 - (void)updateStatus:(NSTimer*)timer
 - (void)updateStatus:(NSTimer*)timer
 {	
 {	
+	//NSLog(@"foo");
 	[self checkRequestStatus];
 	[self checkRequestStatus];
 	if ([self complete] || [self error]) {
 	if ([self complete] || [self error]) {
-		if (![self error]) {
-			[self willChangeValueForKey:@"isFinished"];
-			[self didChangeValueForKey:@"isFinished"];
-		}
 		[timer invalidate];
 		[timer invalidate];
 		CFRunLoopStop(CFRunLoopGetCurrent());
 		CFRunLoopStop(CFRunLoopGetCurrent());
 	}
 	}
@@ -1025,6 +1047,9 @@ static BOOL isiPhoneOS2;
 	// readStream will be null if we aren't currently running (perhaps we're waiting for a delegate to supply credentials)
 	// readStream will be null if we aren't currently running (perhaps we're waiting for a delegate to supply credentials)
 	if (readStream) {
 	if (readStream) {
 		
 		
+		// If we have a post body
+		if ([self postLength]) {
+		
 			// Find out if we've sent any more data than last time, and reset the timeout if so
 			// Find out if we've sent any more data than last time, and reset the timeout if so
 			if (totalBytesSent > lastBytesSent) {
 			if (totalBytesSent > lastBytesSent) {
 				[self setLastActivityTime:[NSDate date]];
 				[self setLastActivityTime:[NSDate date]];
@@ -1035,6 +1060,8 @@ static BOOL isiPhoneOS2;
 			[self setTotalBytesSent:[[(NSNumber *)CFReadStreamCopyProperty(readStream, kCFStreamPropertyHTTPRequestBytesWrittenCount) autorelease] unsignedLongLongValue]];
 			[self setTotalBytesSent:[[(NSNumber *)CFReadStreamCopyProperty(readStream, kCFStreamPropertyHTTPRequestBytesWrittenCount) autorelease] unsignedLongLongValue]];
 			[ASIHTTPRequest incrementBandwidthUsedInLastSecond:(unsigned long)(totalBytesSent-lastBytesSent)];		
 			[ASIHTTPRequest incrementBandwidthUsedInLastSecond:(unsigned long)(totalBytesSent-lastBytesSent)];		
 		
 		
+		}
+			
 		[self updateProgressIndicators];
 		[self updateProgressIndicators];
 
 
 	}
 	}
@@ -1458,12 +1485,12 @@ static BOOL isiPhoneOS2;
 	if ([failedRequest didFailSelector] && [[failedRequest delegate] respondsToSelector:[failedRequest didFailSelector]]) {
 	if ([failedRequest didFailSelector] && [[failedRequest delegate] respondsToSelector:[failedRequest didFailSelector]]) {
 		[[failedRequest delegate] performSelectorOnMainThread:[failedRequest didFailSelector] withObject:failedRequest waitUntilDone:[NSThread isMainThread]];	
 		[[failedRequest delegate] performSelectorOnMainThread:[failedRequest didFailSelector] withObject:failedRequest waitUntilDone:[NSThread isMainThread]];	
 	}
 	}
-	[self willChangeValueForKey:@"isFinished"];
-	[self didChangeValueForKey:@"isFinished"];
 	
 	
 	if ([self mainRequest]) {
 	if ([self mainRequest]) {
 		[[self mainRequest] failWithError:[self error]];
 		[[self mainRequest] failWithError:[self error]];
 	}
 	}
+	
+	[self markAsFinished];
 }
 }
 
 
 #pragma mark parsing HTTP response headers
 #pragma mark parsing HTTP response headers
@@ -2258,14 +2285,12 @@ static BOOL isiPhoneOS2;
 	if ([self needsRedirect]) {
 	if ([self needsRedirect]) {
 		return;
 		return;
 	}
 	}
-//	long long bufferSize = 2048;
-//	if (contentLength > 262144) {
-//		bufferSize = 65536;
-//	} else if (contentLength > 65536) {
-//		bufferSize = 16384;
-//	}
-
-	long long bufferSize = 262144;
+	long long bufferSize = 16384;
+	if (contentLength > 262144) {
+		bufferSize = 262144;
+	} else if (contentLength > 65536) {
+		bufferSize = 65536;
+	}
 	
 	
 	// Reduce the buffer size if we're receiving data too quickly when bandwidth throttling is active
 	// Reduce the buffer size if we're receiving data too quickly when bandwidth throttling is active
 	// This just augments the throttling done in measureBandwidthUsage to reduce the amount we go over the limit
 	// This just augments the throttling done in measureBandwidthUsage to reduce the amount we go over the limit
@@ -2289,7 +2314,7 @@ static BOOL isiPhoneOS2;
 	}
 	}
 	
 	
 	
 	
-
+	//NSLog(@"read");
     UInt8 buffer[bufferSize];
     UInt8 buffer[bufferSize];
     CFIndex bytesRead = CFReadStreamRead(readStream, buffer, sizeof(buffer));
     CFIndex bytesRead = CFReadStreamRead(readStream, buffer, sizeof(buffer));
 
 
@@ -2398,6 +2423,14 @@ static BOOL isiPhoneOS2;
 	} else {
 	} else {
 		[self requestFinished];
 		[self requestFinished];
 	}
 	}
+	[self markAsFinished];
+}
+
+- (void)markAsFinished
+{
+	[self willChangeValueForKey:@"isFinished"];
+	[self didChangeValueForKey:@"isFinished"];
+	CFRunLoopStop(CFRunLoopGetCurrent());
 }
 }
 
 
 
 
@@ -2410,7 +2443,6 @@ static BOOL isiPhoneOS2;
 	
 	
 	if (![self error]) { // We may already have handled this error
 	if (![self error]) { // We may already have handled this error
 		
 		
-		
 		NSString *reason = @"A connection failure occurred";
 		NSString *reason = @"A connection failure occurred";
 		
 		
 		// We'll use a custom error message for SSL errors, but you should always check underlying error if you want more details
 		// We'll use a custom error message for SSL errors, but you should always check underlying error if you want more details
@@ -2424,6 +2456,7 @@ static BOOL isiPhoneOS2;
 		
 		
 		[self failWithError:[NSError errorWithDomain:NetworkRequestErrorDomain code:ASIConnectionFailureErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:reason,NSLocalizedDescriptionKey,underlyingError,NSUnderlyingErrorKey,nil]]];
 		[self failWithError:[NSError errorWithDomain:NetworkRequestErrorDomain code:ASIConnectionFailureErrorType userInfo:[NSDictionary dictionaryWithObjectsAndKeys:reason,NSLocalizedDescriptionKey,underlyingError,NSUnderlyingErrorKey,nil]]];
 	}
 	}
+	[self checkRequestStatus];
 }
 }
 
 
 #pragma mark managing the read stream
 #pragma mark managing the read stream

@@ -24,7 +24,8 @@
 
 
 - (void)setUp
 - (void)setUp
 {
 {
-	[self setTestURL:[NSURL URLWithString:@"http://allseeing-i.com"]];
+	[self setTestURL:[NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/the_great_american_novel_%28abridged%29.txt"]];
+	//[self setTestURL:[NSURL URLWithString:@"http://allseeing-i.com"]];
 }
 }
 
 
 - (void)testASIHTTPRequestSynchronousPerformance
 - (void)testASIHTTPRequestSynchronousPerformance
@@ -47,7 +48,6 @@
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
 		[request setUseCookiePersistance:NO];
 		[request setUseCookiePersistance:NO];
 		[request setUseSessionPersistance:NO];
 		[request setUseSessionPersistance:NO];
-		//[request setShouldRunInBackgroundThread:YES];
 		[request startSynchronous];
 		[request startSynchronous];
 		if ([request error]) {
 		if ([request error]) {
 			NSLog(@"Request failed - cannot proceed with test");
 			NSLog(@"Request failed - cannot proceed with test");
@@ -116,7 +116,7 @@
 	[self performSelectorOnMainThread:@selector(startASIHTTPRequests) withObject:nil waitUntilDone:NO];
 	[self performSelectorOnMainThread:@selector(startASIHTTPRequests) withObject:nil waitUntilDone:NO];
 }
 }
 
 
-- (void)testASIHTTPRequestAsyncPerformanceWithQueue
+- (void)testQueuedASIHTTPRequestAsyncPerformance
 {
 {
 	[self performSelectorOnMainThread:@selector(startASIHTTPRequestsWithQueue) withObject:nil waitUntilDone:NO];
 	[self performSelectorOnMainThread:@selector(startASIHTTPRequestsWithQueue) withObject:nil waitUntilDone:NO];
 }
 }
@@ -129,13 +129,15 @@
 	[self setTestStartDate:[NSDate date]];
 	[self setTestStartDate:[NSDate date]];
 	int i;
 	int i;
 	for (i=0; i<10; i++) {
 	for (i=0; i<10; i++) {
-		ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:[NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/the_great_american_novel_(abridged).txt"]];
+		ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:testURL];
 		//Send the same headers as NSURLRequest
 		//Send the same headers as NSURLRequest
 		[request addRequestHeader:@"Pragma" value:@"no-cache"];
 		[request addRequestHeader:@"Pragma" value:@"no-cache"];
 		[request addRequestHeader:@"Accept" value:@"*/*"];
 		[request addRequestHeader:@"Accept" value:@"*/*"];
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
+		[request setUseCookiePersistance:NO];
+		[request setUseSessionPersistance:NO];
 		[request setDelegate:self];
 		[request setDelegate:self];
-		[request start];
+		[request startAsynchronous];
 	}
 	}
 }
 }
 
 
@@ -146,13 +148,17 @@
 	[self setTestStartDate:[NSDate date]];
 	[self setTestStartDate:[NSDate date]];
 	int i;
 	int i;
 	NSOperationQueue *queue = [[[NSOperationQueue alloc] init] autorelease];
 	NSOperationQueue *queue = [[[NSOperationQueue alloc] init] autorelease];
+	[queue setMaxConcurrentOperationCount:4];
 	for (i=0; i<10; i++) {
 	for (i=0; i<10; i++) {
-		ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:[NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/the_great_american_novel_(abridged).txt"]];
+		ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:testURL];
 		//Send the same headers as NSURLRequest
 		//Send the same headers as NSURLRequest
 		[request addRequestHeader:@"Pragma" value:@"no-cache"];
 		[request addRequestHeader:@"Pragma" value:@"no-cache"];
 		[request addRequestHeader:@"Accept" value:@"*/*"];
 		[request addRequestHeader:@"Accept" value:@"*/*"];
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
 		[request addRequestHeader:@"Accept-Language" value:@"en/us"];
+		[request setUseCookiePersistance:NO];
+		[request setUseSessionPersistance:NO];
 		[request setDelegate:self];
 		[request setDelegate:self];
+		[request setShouldRunInBackgroundThread:YES];
 		[queue addOperation:request];
 		[queue addOperation:request];
 	}
 	}
 }
 }
@@ -185,7 +191,7 @@
 	
 	
 	int i;
 	int i;
 	for (i=0; i<10; i++) {
 	for (i=0; i<10; i++) {
-		NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/the_great_american_novel_(abridged).txt"] cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:10];
+		NSURLRequest *request = [NSURLRequest requestWithURL:testURL cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:10];
 		[[self responseData] addObject:[NSMutableData data]];
 		[[self responseData] addObject:[NSMutableData data]];
 		NSURLConnectionSubclass *connection = [[[NSURLConnectionSubclass alloc] initWithRequest:request delegate:self startImmediately:YES] autorelease];
 		NSURLConnectionSubclass *connection = [[[NSURLConnectionSubclass alloc] initWithRequest:request delegate:self startImmediately:YES] autorelease];
 		[connection setTag:i];		
 		[connection setTag:i];