Skip to content

add variable buffer size #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IldarMustakaev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add variable buffer size #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions TCBlobDownload/TCBlobDownload/TCBlobDownloadManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@
error:(void (^)(NSError *error))errorBlock
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock;

/**
* @param bufferSizeKb - save download state every "bufferSizeKb" kilobytes for this file.
* */
- (TCBlobDownloader *)startDownloadWithURL:(NSURL *)url
customPath:(NSString *)customPathOrNil
firstResponse:(void (^)(NSURLResponse *response))firstResponseBlock
progress:(void (^)(uint64_t receivedLength, uint64_t totalLength, NSInteger remainingTime, float progress))progressBlock
error:(void (^)(NSError *error))errorBlock
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock
bufferSizeKb:(NSUInteger)bufferSizeKb;

/**
Starts an already instanciated `TCBlobDownloader` object.

Expand Down
27 changes: 25 additions & 2 deletions TCBlobDownload/TCBlobDownload/TCBlobDownloadManager.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
// Copyright (c) 2013 Thibault Charbonnier. All rights reserved.
//

static double const kDefaultBufferSizeKb = 1024; // 1 MB

#import "TCBlobDownloadManager.h"
#import "TCBlobDownloader.h"

Expand Down Expand Up @@ -66,16 +68,37 @@ - (TCBlobDownloader *)startDownloadWithURL:(NSURL *)url
error:(void (^)(NSError *error))errorBlock
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock
{

TCBlobDownloader *downloader = [self startDownloadWithURL:url
customPath:customPathOrNil
firstResponse:firstResponseBlock
progress:progressBlock
error:errorBlock
complete:completeBlock
bufferSizeKb:kDefaultBufferSizeKb];

return downloader;
}

- (TCBlobDownloader *)startDownloadWithURL:(NSURL *)url
customPath:(NSString *)customPathOrNil
firstResponse:(void (^)(NSURLResponse *response))firstResponseBlock
progress:(void (^)(uint64_t receivedLength, uint64_t totalLength, NSInteger remainingTime, float progress))progressBlock
error:(void (^)(NSError *error))errorBlock complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock
bufferSizeKb:(NSUInteger)bufferSizeKb {

NSString *downloadPath = customPathOrNil ? customPathOrNil : self.defaultDownloadPath;

TCBlobDownloader *downloader = [[TCBlobDownloader alloc] initWithURL:url
downloadPath:downloadPath
firstResponse:firstResponseBlock
progress:progressBlock
error:errorBlock
complete:completeBlock];
[self.operationQueue addOperation:downloader];
complete:completeBlock
bufferSizeKb:bufferSizeKb];


[self.operationQueue addOperation:downloader];
return downloader;
}

Expand Down
5 changes: 4 additions & 1 deletion TCBlobDownload/TCBlobDownload/TCBlobDownloader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ extern NSString * const TCBlobDownloadErrorHTTPStatusKey;
*/
extern NSString * const TCBlobDownloadErrorDomain;

static const NSUInteger byte = 1024;
/**
The possible error codes for a `TCBlobDownloader` operation. When an error block or the corresponding delegate method are called, an `NSError` instance is passed as parameter. If the domain of this `NSError` is TCBlobDownload's, the `code` parameter will be set to one of these values.

Expand Down Expand Up @@ -190,6 +191,7 @@ typedef NS_ENUM(NSUInteger, TCBlobDownloadState) {
@param progressBlock This block is called on each response from the server while the download is occurring. Can be `nil`. If the remaining time has not been calculated yet, the value is `-1`.
@param errorBlock Called when an error occur during the download. If this block is called, the download will be cancelled just after. Can be `nil`.
@param completeBlock Called when the download is completed or cancelled. Can be `nil`. If the download has been cancelled with the parameter `removeFile` set to `YES`, then the `pathToFile` parameter is `nil`. The `TCBlobDownloader` operation will be removed from `TCBlobDownloadManager` just after this block is called.
* @param bufferSizeBytes - save download state every "bufferSizeBytes" for this file.
@return The newly created `TCBlobDownloader`.

@since 1.3
Expand All @@ -199,7 +201,8 @@ typedef NS_ENUM(NSUInteger, TCBlobDownloadState) {
firstResponse:(void (^)(NSURLResponse *response))firstResponseBlock
progress:(void (^)(uint64_t receivedLength, uint64_t totalLength, NSInteger remainingTime, float progress))progressBlock
error:(void (^)(NSError *error))errorBlock
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock;
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock
bufferSizeKb:(NSUInteger)bufferSizeKb;

/**
Cancels the download. Remove already downloaded parts of the file from the disk is asked.
Expand Down
6 changes: 4 additions & 2 deletions TCBlobDownload/TCBlobDownload/TCBlobDownloader.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
// Copyright (c) 2013 Thibault Charbonnier. All rights reserved.
//

static const double kBufferSize = 1000*1000; // 1 MB
static const NSTimeInterval kDefaultRequestTimeout = 30;
static const NSInteger kNumberOfSamples = 5;

Expand All @@ -25,6 +24,7 @@ @interface TCBlobDownloader ()
@property (nonatomic, strong) NSURLConnection *connection;
@property (nonatomic, strong) NSMutableData *receivedDataBuffer;
@property (nonatomic, strong) NSFileHandle *file;
@property(nonatomic) NSUInteger bufferSizeBytes;
// Speed rate and remaining time
@property (nonatomic, strong) NSTimer *speedTimer;
@property (nonatomic, strong) NSMutableArray *samplesOfDownloadedBytes;
Expand Down Expand Up @@ -87,13 +87,15 @@ - (instancetype)initWithURL:(NSURL *)url
progress:(void (^)(uint64_t receivedLength, uint64_t totalLength, NSInteger remainingTime, float progress))progressBlock
error:(void (^)(NSError *error))errorBlock
complete:(void (^)(BOOL downloadFinished, NSString *pathToFile))completeBlock
bufferSizeKb:(NSUInteger)bufferSizeKb
{
self = [self initWithURL:url downloadPath:pathToDL delegate:nil];
if (self) {
self.firstResponseBlock = firstResponseBlock;
self.progressBlock = progressBlock;
self.errorBlock = errorBlock;
self.completeBlock = completeBlock;
self.bufferSizeBytes = bufferSizeKb * byte;
}
return self;
}
Expand Down Expand Up @@ -247,7 +249,7 @@ - (void)connection:(NSURLConnection*)connection didReceiveData:(NSData *)data
(float) self.receivedDataLength / self.expectedDataLength * 100,
(long) self.receivedDataLength, (long) self.expectedDataLength);

if (self.receivedDataBuffer.length > kBufferSize && [self isExecuting]) {
if (self.receivedDataBuffer.length > self.bufferSizeBytes && [self isExecuting]) {
[self.file writeData:self.receivedDataBuffer];
[self.receivedDataBuffer setData:nil];
}
Expand Down