Refactor timer code into separate utility class #53
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| #import <Foundation/Foundation.h> | ||
|
|
||
| @class MMEBackgroundLocationServiceTimeoutHandler; | ||
| @protocol MMEUIApplicationWrapper; | ||
|
|
||
| @protocol MMEBackgroundLocationServiceTimeoutDelegate | ||
| - (BOOL)timeoutHandlerShouldCheckForTimeout:(MMEBackgroundLocationServiceTimeoutHandler *)handler; | ||
| - (void)timeoutHandlerDidTimeout:(MMEBackgroundLocationServiceTimeoutHandler *)handler; | ||
| - (void)timeoutHandlerBackgroundTaskDidExpire:(MMEBackgroundLocationServiceTimeoutHandler *)handler; | ||
|
|
||
| @end | ||
|
|
||
| @interface MMEBackgroundLocationServiceTimeoutHandler: NSObject | ||
|
|
||
| @property (nonatomic, weak) id<MMEBackgroundLocationServiceTimeoutDelegate> delegate; | ||
| @property (nonatomic, readonly) NSTimer *timer; | ||
| - (instancetype)initWithApplication:(id<MMEUIApplicationWrapper>)application; | ||
| - (void)startTimer; | ||
| - (void)stopTimer; | ||
| @end | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| #import "MMEBackgroundLocationServiceTimeoutHandler.h" | ||
| #import "MMEUIApplicationWrapper.h" | ||
|
|
||
| static const NSTimeInterval MMELocationManagerHibernationTimeout = 300.0; | ||
| static const NSTimeInterval MMELocationManagerHibernationPollInterval = 5.0; | ||
|
|
||
| @interface MMEBackgroundLocationServiceTimeoutHandler () | ||
|
|
||
| @property (nonatomic) id<MMEUIApplicationWrapper> application; | ||
| @property (nonatomic) NSDate *expiration; | ||
| @property (nonatomic, readwrite) NSTimer *timer; | ||
| @property (nonatomic) UIBackgroundTaskIdentifier backgroundTaskId; | ||
|
|
||
| @end | ||
|
|
||
| #pragma mark - MMEBackgroundLocationServiceTimeoutHandler | ||
|
|
||
| @implementation MMEBackgroundLocationServiceTimeoutHandler | ||
|
|
||
| - (instancetype)initWithApplication:(id<MMEUIApplicationWrapper>)application { | ||
| self = [super init]; | ||
| if (self) { | ||
| _application = application; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (void)timeoutAllowedCheck:(NSTimer *)timer { | ||
| id<MMEBackgroundLocationServiceTimeoutDelegate> delegate = self.delegate; | ||
|
|
||
| if (!delegate) { | ||
| dispatch_async(dispatch_get_main_queue(), ^{ | ||
| [self stopTimer]; | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| if (![delegate timeoutHandlerShouldCheckForTimeout:self]) { | ||
| self.expiration = [[NSDate date] dateByAddingTimeInterval:MMELocationManagerHibernationTimeout]; | ||
| return; | ||
| } | ||
|
|
||
| if (!self.expiration) { | ||
| return; | ||
| } | ||
|
|
||
| NSTimeInterval timeIntervalSinceTimeoutAllowed = [[NSDate date] timeIntervalSinceDate:self.expiration]; | ||
| if (timeIntervalSinceTimeoutAllowed > 0) { | ||
| dispatch_async(dispatch_get_main_queue(), ^{ | ||
| [self stopTimer]; | ||
| [delegate timeoutHandlerDidTimeout:self]; | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| - (void)startTimer { | ||
| if (self.timer) { | ||
| // Changed from return, to ensure we get a new background task. This matches | ||
| // the previous behaviour (prior to refactoring) | ||
| [self stopTimer]; | ||
| } | ||
|
|
||
| __weak __typeof__(self) weakself = self; | ||
| NSAssert(self.backgroundTaskId == UIBackgroundTaskInvalid, @"Background task Id should be invalid"); | ||
| self.backgroundTaskId = [self.application beginBackgroundTaskWithExpirationHandler:^{ | ||
| __typeof__(self) strongSelf = weakself; | ||
|
|
||
| [strongSelf stopTimer]; | ||
| [strongSelf.delegate timeoutHandlerBackgroundTaskDidExpire:strongSelf]; | ||
|
|
||
| }]; | ||
|
|
||
| self.expiration = [[NSDate date] dateByAddingTimeInterval:MMELocationManagerHibernationTimeout]; | ||
| self.timer = [NSTimer scheduledTimerWithTimeInterval:MMELocationManagerHibernationPollInterval target:self selector:@selector(timeoutAllowedCheck:) userInfo:nil repeats:YES]; | ||
| } | ||
|
|
||
| - (void)stopTimer { | ||
| if (UIBackgroundTaskInvalid != self.backgroundTaskId) { | ||
| [self.application endBackgroundTask:self.backgroundTaskId]; | ||
| self.backgroundTaskId = UIBackgroundTaskInvalid; | ||
| } | ||
|
|
||
| [self.timer invalidate]; | ||
| self.timer = nil; | ||
| self.expiration = nil; | ||
| } | ||
|
|
||
| @end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this is an internal application, would it be good if we check first if the delegate already implements the method?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These aren't
optionalprotocol methods, so there's no need to check to see if the delegate already implements it. The compiler will warn if the client hasn't implemented them.Since these are really internal methods, I didn't see a need to make them optional.