iOS / asi-http-request

Go to a project
Toggle navigation Toggle navigation pinning
Ben Copsey
72c3d522 1 parent c002cffe

Rework throttling to unschedule the stream rather than sleep the thread

Inline Side-by-side
Showing 4 changed files with 67 additions and 13 deletions
... ... @@ -319,6 +319,7 @@ extern unsigned long const ASIWWANBandwidthThrottleAmount;
BOOL isSynchronous;
BOOL inProgress;
BOOL readStreamIsScheduled;
}
#pragma mark init / dealloc
... ... @@ -539,6 +540,8 @@ extern unsigned long const ASIWWANBandwidthThrottleAmount;
// Get a rough average (for the last 5 seconds) of how much bandwidth is being used, in bytes
+ (unsigned long)averageBandwidthUsedPerSecond;
- (void)performThrottling;
// Will return YES is bandwidth throttling is currently in use
+ (BOOL)isBandwidthThrottled;
... ...
... ... @@ -21,7 +21,7 @@
#import "ASIInputStream.h"
// Automatically set on build
NSString *ASIHTTPRequestVersion = @"v1.2-30 2009-12-17";
NSString *ASIHTTPRequestVersion = @"v1.2-31 2009-12-17";
NSString* const NetworkRequestErrorDomain = @"ASIHTTPRequestErrorDomain";
... ... @@ -92,6 +92,7 @@ static NSRecursiveLock *sessionCookiesLock = nil;
// This is so it can make use of any credentials supplied for the other request, if they are appropriate
static NSRecursiveLock *delegateAuthenticationLock = nil;
static NSDate *throttleWakeUpTime = nil;
static BOOL isiPhoneOS2;
... ... @@ -440,6 +441,9 @@ static BOOL isiPhoneOS2;
- (void)startSynchronous
{
#if ASIHTTPREQUEST_DEBUG
NSLog(@"Starting synchronous request %@",self);
#endif
[self setInProgress:YES];
@try {
if (![self isCancelled] && ![self complete]) {
... ... @@ -457,6 +461,9 @@ static BOOL isiPhoneOS2;
- (void)start
{
#if ASIHTTPREQUEST_DEBUG
NSLog(@"Starting asynchronous request %@",self);
#endif
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
// If this request is autoreleased, it may be dealloced the next time this runloop gets run
... ... @@ -822,7 +829,11 @@ static BOOL isiPhoneOS2;
}
// Schedule the stream
if (!throttleWakeUpTime || [throttleWakeUpTime timeIntervalSinceDate:[NSDate date]] < 0) {
CFReadStreamScheduleWithRunLoop(readStream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
readStreamIsScheduled = YES;
}
// Start the HTTP connection
if (!CFReadStreamOpen(readStream)) {
... ... @@ -901,6 +912,10 @@ static BOOL isiPhoneOS2;
NSDate *now = [NSDate date];
[self performThrottling];
// See if we need to timeout
if (lastActivityTime && timeOutSeconds > 0 && [now timeIntervalSinceDate:lastActivityTime] > timeOutSeconds) {
... ... @@ -950,8 +965,6 @@ static BOOL isiPhoneOS2;
[self updateProgressIndicators];
// Measure bandwidth used, and throttle if nescessary
[ASIHTTPRequest measureBandwidthUsage];
}
// This thread should wait for 1/4 second for the stream to do something
... ... @@ -1339,6 +1352,9 @@ static BOOL isiPhoneOS2;
// If you do this, don't forget to call [super requestFinished] to let the queue / delegate know we're done
- (void)requestFinished
{
#if ASIHTTPREQUEST_DEBUG
NSLog(@"Request finished: %@",self);
#endif
if ([self error] || [self mainRequest]) {
return;
}
... ... @@ -2132,6 +2148,7 @@ static BOOL isiPhoneOS2;
break;
}
[self performThrottling];
[[self cancelledLock] unlock];
}
... ... @@ -2181,7 +2198,7 @@ static BOOL isiPhoneOS2;
UInt8 buffer[bufferSize];
CFIndex bytesRead = CFReadStreamRead(readStream, buffer, sizeof(buffer));
//NSLog(@"Request %@ has read %hi bytes",self,bytesRead);
// Less than zero is an error
if (bytesRead < 0) {
[self handleStreamError];
... ... @@ -2922,6 +2939,38 @@ static BOOL isiPhoneOS2;
#pragma mark bandwidth measurement / throttling
- (void)performThrottling
{
if (!readStream) {
return;
}
[ASIHTTPRequest measureBandwidthUsage];
if ([ASIHTTPRequest isBandwidthThrottled]) {
//NSLog(@"%@",[NSString stringWithFormat:@"%luKB / second",[ASIHTTPRequest averageBandwidthUsedPerSecond]/1024]);
[bandwidthThrottlingLock lock];
// Handle throttling
if (throttleWakeUpTime) {
if ([throttleWakeUpTime timeIntervalSinceDate:[NSDate date]] > 0) {
if (readStreamIsScheduled) {
CFReadStreamSetClient(readStream, kCFStreamEventNone, NULL, NULL);
CFReadStreamUnscheduleFromRunLoop(readStream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
NSLog(@"Sleeping request %@ until after %@",self,throttleWakeUpTime);
readStreamIsScheduled = NO;
}
} else {
if (!readStreamIsScheduled) {
NSLog(@"Waking up request %@",self);
CFStreamClientContext ctxt = {0, self, NULL, NULL, NULL};
CFReadStreamSetClient(readStream, kNetworkEvents, ReadStreamClientCallBack, &ctxt);
CFReadStreamScheduleWithRunLoop(readStream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
readStreamIsScheduled = YES;
}
}
}
[bandwidthThrottlingLock unlock];
}
}
+ (BOOL)isBandwidthThrottled
{
#if TARGET_OS_IPHONE
... ... @@ -2973,10 +3022,11 @@ static BOOL isiPhoneOS2;
}
}
//NSLog(@"Used: %qi",bandwidthUsedInLastSecond);
NSLog(@"Used: %qi in last period",bandwidthUsedInLastSecond);
[bandwidthUsageTracker addObject:[NSNumber numberWithUnsignedLong:bandwidthUsedInLastSecond]];
[bandwidthMeasurementDate release];
bandwidthMeasurementDate = [[NSDate dateWithTimeIntervalSinceNow:1] retain];
NSLog(@"---New BandWidth measurement date--- %@",bandwidthMeasurementDate);
bandwidthUsedInLastSecond = 0;
NSUInteger measurements = [bandwidthUsageTracker count];
... ... @@ -3005,7 +3055,7 @@ static BOOL isiPhoneOS2;
[bandwidthThrottlingLock lock];
if (!bandwidthMeasurementDate || [bandwidthMeasurementDate timeIntervalSinceNow] < -0) {
[self recordBandwidthUsage];
[ASIHTTPRequest recordBandwidthUsage];
}
// Are we performing bandwidth throttling?
... ... @@ -3017,15 +3067,15 @@ static BOOL isiPhoneOS2;
// How much data can we still send or receive this second?
long long bytesRemaining = (long long)maxBandwidthPerSecond - (long long)bandwidthUsedInLastSecond;
//NSLog(@"%lld bytes allowance remaining",bytesRemaining);
// Have we used up our allowance?
if (bytesRemaining < 0) {
// Yes, put this request to sleep until a second is up, with extra added punishment sleeping time for being very naughty (we have used more bandwidth than we were allowed)
double extraSleepyTime = (-bytesRemaining/(maxBandwidthPerSecond*1.0));
[NSThread sleepUntilDate:[bandwidthMeasurementDate dateByAddingTimeInterval:extraSleepyTime]];
[self recordBandwidthUsage];
[throttleWakeUpTime release];
throttleWakeUpTime = [[bandwidthMeasurementDate dateByAddingTimeInterval:extraSleepyTime] retain];
}
}
[bandwidthThrottlingLock unlock];
... ... @@ -3109,7 +3159,8 @@ static BOOL isiPhoneOS2;
}
if (toRead == 0 || !bandwidthMeasurementDate || [bandwidthMeasurementDate timeIntervalSinceNow] < -0) {
[NSThread sleepUntilDate:bandwidthMeasurementDate];
[throttleWakeUpTime release];
throttleWakeUpTime = [bandwidthMeasurementDate retain];
[self recordBandwidthUsage];
}
[bandwidthThrottlingLock unlock];
... ...
... ... @@ -26,4 +26,4 @@ This config option is not used for apps targeting Mac OS X
// When set to 1, requests will print debug information to the console (currently only used by ASIFormDataRequest)
#define ASIHTTPREQUEST_DEBUG 0
\ No newline at end of file
#define ASIHTTPREQUEST_DEBUG 1
\ No newline at end of file
... ...
... ... @@ -1044,11 +1044,11 @@
// We'll test first without throttling
ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:[NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/the_great_american_novel_%28abridged%29.txt"]];
NSDate *date = [NSDate date];
[request startSynchronous];
//[request startSynchronous];
NSTimeInterval interval =[date timeIntervalSinceNow];
BOOL success = (interval > -7);
GHAssertTrue(success,@"Downloaded the file too slowly - either this is a bug, or your internet connection is too slow to run this test (must be able to download 128KB in less than 7 seconds, without throttling)");
//GHAssertTrue(success,@"Downloaded the file too slowly - either this is a bug, or your internet connection is too slow to run this test (must be able to download 128KB in less than 7 seconds, without throttling)");
// Now we'll test with throttling
[ASIHTTPRequest setMaxBandwidthPerSecond:ASIWWANBandwidthThrottleAmount];
... ...