hank
2017-06-14 a0a84333e64f1e94ae9d0f69545037c60e781842
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
//
//  TWTRNetworkingPipeline.h
//  TwitterKit
//
//  Copyright (c) 2015 Twitter. All rights reserved.
//
 
#import <TwitterCore/TWTRSessionStore.h>
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol TWTRNetworkingResponseValidating;
 
typedef void (^TWTRNetworkingPipelineCallback)(NSData *_Nullable data, NSURLResponse *_Nullable response, NSError *_Nullable error);
 
@interface TWTRNetworkingPipeline : NSObject
 
/**
 *if set, this object will be used to validate network responses.
 */
@property (nonatomic, readonly, nullable) id<TWTRNetworkingResponseValidating> responseValidator;
 
/**
 * Use the initWithURLSession: method instead.
 */
- (instancetype)init NS_UNAVAILABLE;
 
/**
 * Returns an instance of the networking pipeline
 *
 * @param URLSession URLSession object to invoke network requests on.
 * @param responseValidator an optional response validator to use to validate responses.
 */
- (instancetype)initWithURLSession:(NSURLSession *)URLSession responseValidator:(nullable id<TWTRNetworkingResponseValidating>)responseValidator NS_DESIGNATED_INITIALIZER;
 
/**
 * Enqueues a request in the pipeline.
 *
 * @param request The HTTP Request to send
 * @param sessionStore The session store that will provide the session.
 * @param userID The userId to sign the request for or nil if using the guest session
 * @param completion The completion block to invoke on completion.
 */
- (NSProgress *)enqueueRequest:(NSURLRequest *)request sessionStore:(id<TWTRSessionStore>)sessionStore;
- (NSProgress *)enqueueRequest:(NSURLRequest *)request sessionStore:(id<TWTRSessionStore>)sessionStore requestingUser:(nullable NSString *)userID;
 
/**
 *  Enqueues a request in the pipeline.
 *
 *  @param request      The HTTP request to send.
 *  @param sessionStore The session store that will provide the session.
 *  @param userID       The user to sign the request for or nil if using the guest session.
 *  @param completion   The completion block to invoke on completion.
 */
- (NSProgress *)enqueueRequest:(NSURLRequest *)request sessionStore:(id<TWTRSessionStore>)sessionStore requestingUser:(nullable NSString *)userID completion:(nullable TWTRNetworkingPipelineCallback)completion;
 
@end
 
@protocol TWTRNetworkingResponseValidating <NSObject>
 
@required
/**
 * This method should return an NO if the response represents an error state.
 */
- (BOOL)validateResponse:(nullable NSURLResponse *)response data:(nullable NSData *)data error:(NSError **)error;
 
@end
 
NS_ASSUME_NONNULL_END