MBSessionDownload

MBSessionDownload is best way to download files in your apps. Your apps can download files in a foreground or background.

Requires iOS 7.0 or later.

======

Features

Download files in background threads.
Use blocks!
Pause and resume a download.
Custom download path and auto path creation.
Continue to download files when your app is in a background

Methods

MBDownloadManager

+(MBDownloadManager *)defaultManager;
-(NSUInteger)makeSessionWithProgressBlock:(ProgressBlock)progressBlock
                               errorBlock:(ErrorBlock)errorBlock
                            completeBolck:(CompleteBlock)completeBlock;


-(NSUInteger)startDownloadWithURL:(NSString *)downloadURLString sessionID:(NSUInteger)sessionID;
-(NSUInteger)startDownloadWithURL:(NSString *)downloadURLString destination:(NSString *)destination sessionID:(NSUInteger)sessionID;


-(void)pauseDownloadWithIdentifier:(NSUInteger)taskID;
-(void)pauseAllTasks;


-(void)stopDownloadWithIdentifier:(NSUInteger)taskID;
-(void)stopAllTasks;

MBURLSessionManager

-(NSURLSession *)getSessionWithConfiguration:(NSURLSessionConfiguration *)configuration
                               progressBlock:(ProgressBlock)progressBlock
                                  errorBlock:(ErrorBlock)errorBlock
                               completeBolck:(CompleteBlock)completeBlock;

Usage

1. Blocks

You can set different process blocks each session. But remember the session ID, that will be used to use a download process you set.

To immediately start a download in the default MBDownloadManager directory (<Application_Home>/temp by default):

#import "MBDowloadManager/MBDownloadManager.h"

_currentSessionID = [[MBDownloadManager defaultManager]
                         makeSessionWithProgressBlock:^(NSUInteger taskID, int64_t bytesWritten,
                                                        int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite){
        
        NSLog(@"received data lenth : %lld \ntotal received data length : %lld \ntotal data length : %lld", bytesWritten, totalBytesWritten, totalBytesExpectedToWrite);
        [_progress setProgress:((double)totalBytesWritten/(double)totalBytesExpectedToWrite)];
        
    } errorBlock:^(NSUInteger taskID, NSError *error){
        
        NSLog(@"download error : %@", [error localizedDescription]);
        
    } completeBolck:^(NSUInteger taskID, BOOL isFinish, NSString *filePath){
        
        if (isFinish) {
            NSLog(@"file path is %@", filePath);
        }
        
    }];


    _currentTaskID = [[MBDownloadManager defaultManager] startDownloadWithURL:DownloadURLString sessionID:_currentSessionID];

If you set a customPath:

_currentTaskID = [[MBDownloadManager defaultManager] startDownloadWithURL:DownloadURLString destination:CUSTOM_PATH sessionID:_currentSessionID];

Pause and resume download:

[[MBDownloadManager defaultManager] pauseDownloadWithIdentifier:taskID];
[[MBDownloadManager defaultManager] pauseAllTasks];

Stop download:

[[MBDownloadManager defaultManager] stopDownloadWithIdentifier:taskID];
[[MBDownloadManager defaultManager] stopAllTasks];

This will create the given path if needed and download the file. Apple recommend putting file to download in <Application_Home>/Library/Caches directory. Remember that you should follow the iOS Data Storage Guidelines.

2. Other things you should know

1 This download manager is made using NSURLSession and NSURLSessionDownloadTask

2 Use EGOCache to save resuming data. EGOCache is following a MIT license.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

neoroman / mbsessiondownload Goto Github PK