mirror of
https://github.com/Swiftgram/Telegram-iOS.git
synced 2025-12-17 11:50:56 +00:00
ff5999fff2
- Reformatting - Fix and amend tests - Split methods for better code readability - Rename `path` to `filePath` make code more comprehensive - Replace `@synchronized` with dispatch queue - Add generics annotation
154 lines
4.8 KiB
Objective-C
154 lines
4.8 KiB
Objective-C
#import <Foundation/Foundation.h>
|
|
#import "HockeySDK.h"
|
|
|
|
#if HOCKEYSDK_FEATURE_TELEMETRY
|
|
|
|
#import "HockeySDKNullability.h"
|
|
@class BITPersistence;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* Utility class that's responsible for sending a bundle of data to the server
|
|
*/
|
|
@interface BITSender : NSObject
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Initialize instance
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Initializes a sender instance with a given persistence object.
|
|
*
|
|
* @param persistence used for loading files before sending them out
|
|
* @param serverURL the endpoint URL for telemetry data
|
|
* @return an initialized sender instance
|
|
*/
|
|
- (instancetype)initWithPersistence:(BITPersistence *)persistence serverURL:(NSURL *)serverURL;
|
|
|
|
/**
|
|
* We use this queue to keep track of the number of currently running requests
|
|
*/
|
|
@property (nonatomic, strong) dispatch_queue_t requestsCountQueue;
|
|
|
|
/**
|
|
* A queue which is used to handle BITHTTPOperation completion blocks.
|
|
*/
|
|
@property (nonatomic, strong) dispatch_queue_t senderTasksQueue;
|
|
|
|
/**
|
|
* A queue for processing http operations (iOS < 7)
|
|
*/
|
|
@property (nonatomic, strong) NSOperationQueue *operationQueue;
|
|
|
|
/**
|
|
* The endpoint url of the telemetry server.
|
|
*/
|
|
@property (nonatomic, copy) NSString *endpointPath;
|
|
|
|
/**
|
|
* The max number of request that can run at a time.
|
|
*/
|
|
@property NSUInteger maxRequestCount;
|
|
|
|
/**
|
|
* The number of requests that are currently running.
|
|
*/
|
|
@property NSUInteger runningRequestsCount;
|
|
|
|
/**
|
|
* BaseURL to which relative paths are appended.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSURL *serverURL;
|
|
|
|
/**
|
|
* The persistence instance used for loading files before sending them out.
|
|
*/
|
|
@property (nonatomic, strong, readonly) BITPersistence *persistence;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Sending data
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Creates a request for the given data and forwards that in order to send it out.
|
|
*
|
|
* @param data the telemetry data which should be sent
|
|
* @param filePath a reference of filePath to the file which should be sent (needed to delete it after sending)
|
|
*/
|
|
- (void)sendData:(NSData *)data withFilePath:(NSString * )filePath;
|
|
|
|
/**
|
|
* Triggers sending the saved data on a background thread. Does nothing if nothing has been persisted, yet. This method should be called by BITTelemetryManager on app start.
|
|
*/
|
|
- (void)sendSavedDataAsync;
|
|
|
|
/**
|
|
* Triggers sending the saved data.
|
|
*/
|
|
- (void)sendSavedData;
|
|
|
|
/**
|
|
* Creates a HTTP operation/session task and puts it to the queue.
|
|
*
|
|
* @param request a request for sending a data object to the telemetry server
|
|
* @param path path to the file which should be sent
|
|
* @param isUrlSessionSupported a flag which determines whether to use NSURLConnection or NSURLSession for sending out data
|
|
*/
|
|
- (void)sendRequest:(NSURLRequest *)request filePath:(NSString *)path;
|
|
|
|
/**
|
|
* Helper method that checks whether the current OS supports NSURLSession
|
|
*
|
|
* @returns YES if NSURLSession is available
|
|
*/
|
|
- (BOOL)isURLSessionSupported;
|
|
|
|
- (void)sendUsingURLSessionWithRequest:(NSURLRequest *)request filePath:(NSString *)filePath;
|
|
|
|
- (void)sendUsingURLConnectionWithRequest:(NSURLRequest *)request filePath:(NSString *)filePath;
|
|
|
|
/**
|
|
* Resumes the given NSURLSessionDataTask instance.
|
|
*
|
|
* @param sessionDataTask the task which should be resumed
|
|
*/
|
|
- (void)resumeSessionDataTask:(NSURLSessionDataTask *)sessionDataTask;
|
|
|
|
/**
|
|
* Deletes or unblocks sent file according to the given response code.
|
|
*
|
|
* @param statusCode the status code of the response
|
|
* @param responseData the data of the response
|
|
* @param filePath the path of the file which content has been sent to the server
|
|
* @param error an error object sent from the server
|
|
*/
|
|
- (void)handleResponseWithStatusCode:(NSInteger)statusCode responseData:(NSData *)responseData filePath:(NSString *)filePath error:(NSError *)error;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Helper
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns a request for sending data to the telemetry sender.
|
|
*
|
|
* @param data the data which should be sent
|
|
*
|
|
* @return a request which contains the given data
|
|
*/
|
|
- (NSURLRequest *)requestForData:(NSData *)data;
|
|
|
|
/**
|
|
* Returns if data should be deleted based on a given status code.
|
|
*
|
|
* @param statusCode the status code which is part of the response object
|
|
*
|
|
* @return YES if data should be deleted, NO if the payload should be sent at a later time again.
|
|
*/
|
|
- (BOOL)shouldDeleteDataWithStatusCode:(NSInteger)statusCode;
|
|
|
|
@end
|
|
NS_ASSUME_NONNULL_END
|
|
|
|
#endif /* HOCKEYSDK_FEATURE_TELEMETRY */
|