-
Notifications
You must be signed in to change notification settings - Fork 72
/
CKStreamBasedConnection.h
182 lines (143 loc) · 5.97 KB
/
CKStreamBasedConnection.h
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*
Copyright (c) 2005, Greg Hulands <ghulands@mac.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
Neither the name of Greg Hulands nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import <Foundation/Foundation.h>
#import <Connection/CKAbstractQueueConnection.h>
#import <Security/SecureTransport.h>
#import <Security/Security.h>
/*
* A Stream Based Connection runs the streams in a background thread and handles the
* delegate notifications of the streams.
*
* Properties used:
* FileCheckingTranscript
*
*/
@protocol OutputStream, InputStream;
#if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_5
@protocol NSStreamDelegate <NSObject> @end
#endif
@interface CKStreamBasedConnection : CKAbstractQueueConnection <NSStreamDelegate>
{
NSThread *_createdThread;
id<OutputStream> _sendStream;
id<InputStream> _receiveStream;
BOOL _isForceDisconnecting;
NSMutableData *_sendBuffer;
NSLock *_sendBufferLock;
// speed support
NSTimeInterval _lastChunkSent;
NSTimeInterval _lastChunkReceived;
double _uploadSpeed;
double _downloadSpeed;
// This is a peer connection that is used to check if files exist
id <CKConnection> _fileCheckingConnection;
NSLock *_fileCheckLock;
NSString *_fileCheckInFlight;
//Peer connection support for recursive S3 renaming
NSMutableArray *_recursiveS3RenamesQueue;
NSMutableArray *_recursivelyRenamedDirectoriesToDelete;
id <CKConnection> _recursiveS3RenameConnection;
unsigned _numberOfS3RenameListingsRemaining;
unsigned _numberOfS3RenamesRemaining;
unsigned _numberOfS3RenameDirectoryDeletionsRemaining;
NSLock *_recursiveS3RenameLock;
// These peer connections are used to speed up recursive directory deletion
NSMutableArray *_recursiveDeletionsQueue;
id previousDelegate;
NSString *previousWorkingDirectory;
id <CKConnection> _recursiveDeletionConnection;
unsigned _numberOfDeletionListingsRemaining;
unsigned _numberOfDirDeletionsRemaining;
NSMutableArray *_emptyDirectoriesToDelete;
NSMutableArray *_filesToDelete;
NSLock *_recursiveDeletionLock;
// Peer connection support for recursive download
id <CKConnection> _recursiveDownloadConnection;
unsigned _numberOfDownloadListingsRemaining;
NSMutableArray *_recursiveDownloadQueue;
NSLock *_recursiveDownloadLock;
struct __streamflags {
unsigned sendOpen : 1;
unsigned readOpen : 1;
unsigned receiveHasBytes : 1;
unsigned wantsSSL : 1;
unsigned sslOn : 1;
unsigned verifySSLCert : 1;
unsigned allowsBadCerts : 1; // for data transfer connections
unsigned isNegotiatingSSL : 1;
unsigned initializedSSL : 1;
unsigned reportedError : 1;
unsigned isDeleting: 1;
unsigned isDownloading: 1;
unsigned isRecursivelyRenamingForS3: 1;
unsigned unused: 22;
} myStreamFlags;
// SSL Support
SSLContextRef mySSLContext;
SecIdentityRef mySSLIdentity;
NSMutableData *mySSLSendBuffer;
NSMutableData *mySSLRecevieBuffer;
NSMutableData *mySSLRawReadBuffer;
NSMutableData *mySSLEncryptedSendBuffer;
}
- (BOOL)openStreamsToPort:(unsigned)port;
- (void)scheduleStreamsOnRunLoop;
- (void)setSendStream:(NSStream *)stream;
- (void)setReceiveStream:(NSStream *)stream;
- (NSStream *)sendStream;
- (NSStream *)receiveStream;
- (void)closeStreams;
- (BOOL)sendStreamOpen;
- (BOOL)receiveStreamOpen;
// subclasses can override
- (void)sendStreamDidOpen;
- (void)sendStreamDidClose;
- (void)receiveStreamDidOpen;
- (void)receiveStreamDidClose;
- (void)handleSendStreamEvent:(NSStreamEvent)theEvent;
- (void)handleReceiveStreamEvent:(NSStreamEvent)theEvent;
- (void)stream:(id<OutputStream>)stream sentBytesOfLength:(unsigned)length;
- (void)stream:(id<InputStream>)stream readBytesOfLength:(unsigned)length;
// Get the local command port
- (CFSocketNativeHandle)socket;
- (unsigned)localPort;
- (NSString *)remoteIPAddress;
// Subclass needs to override these methods
- (void)processReceivedData:(NSData *)data;
- (void)sendCommand:(id)command;
- (unsigned)sendData:(NSData *)data; // returns how many bytes it sent. If the buffer was not empty and it was appended, then it will return 0
- (NSData *)availableData;
- (int)availableData:(NSData **)data ofLength:(int)length;
// These are called on the background thread
- (void)threadedConnect;
- (void)threadedDisconnect;
- (void)threadedForceDisconnect;
// SSL Support
- (void)setSSLOn:(BOOL)flag;
@end
extern NSString *StreamBasedErrorDomain;
extern NSString *SSLErrorDomain;
enum { StreamErrorFailedSocketCreation = 7000, StreamErrorTimedOut };
extern const unsigned int kStreamChunkSize;
enum { CONNECT = 0, COMMAND, ABORT, DISCONNECT, FORCE_DISCONNECT, CHECK_FILE_QUEUE, KILL_THREAD }; // port messages