forked from andrewfromcali/mcinsight
/
AsyncSocket.m
1566 lines (1324 loc) · 45.1 KB
/
AsyncSocket.m
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// AsyncSocket.m
//
// Created by Dustin Voss on Wed Jan 29 2003.
// This class is in the public domain.
// If used, I'd appreciate it if you credit me.
//
// E-Mail: d-j-v@earthlink.net
//
#import "AsyncSocket.h"
#import <sys/socket.h>
#import <netinet/in.h>
#import <arpa/inet.h>
#import <netdb.h>
#pragma mark Declarations
#define READQUEUE_CAPACITY 5 /* Initial capacity. */
#define WRITEQUEUE_CAPACITY 5 /* Initial capacity. */
#define READALL_CHUNKSIZE 256 /* Incremental increase in buffer size. */
#define WRITE_CHUNKSIZE (4*1024) /* Limit on size of each write pass. */
#define POLL_INTERVAL 1.0 /* Timer to check for overlooked activity. */
NSString *const AsyncSocketException = @"AsyncSocketException";
NSString *const AsyncSocketErrorDomain = @"AsyncSocketErrorDomain";
// This is a mutex lock used by all instances of AsyncSocket, to protect getaddrinfo.
// The man page says it is not thread-safe.
NSString *getaddrinfoLock = @"lock";
enum AsyncSocketFlags
{
kDidCallConnectDeleg = 0x01, // If set, connect delegate has been called.
kDidPassConnectMethod = 0x02, // If set, disconnection results in delegate call.
kForbidReadsWrites = 0x04, // If set, no new reads or writes are allowed.
kDisconnectSoon = 0x08 // If set, disconnect as soon as nothing is queued.
};
@interface AsyncSocket (Private)
- (BOOL) isSocketConnected;
- (BOOL) areStreamsConnected;
- (NSString *) connectedHost: (CFSocketRef)socket;
- (UInt16) connectedPort: (CFSocketRef)socket;
- (NSString *) localHost: (CFSocketRef)socket;
- (UInt16) localPort: (CFSocketRef)socket;
- (NSString *) addressHost: (CFDataRef)cfaddr;
- (UInt16) addressPort: (CFDataRef)cfaddr;
- (void) doCFCallback:(CFSocketCallBackType)type forSocket:(CFSocketRef)sock withAddress:(NSData *)address withData:(const void *)pData;
- (void) doCFReadStreamCallback:(CFStreamEventType)type forStream:(CFReadStreamRef)stream;
- (void) doCFWriteStreamCallback:(CFStreamEventType)type forStream:(CFWriteStreamRef)stream;
- (void) doAcceptWithSocket:(CFSocketNativeHandle)newSocket;
- (void) doFinishConnectWithError:(SInt32)err;
- (BOOL) createStreamsFromNative:(CFSocketNativeHandle)native error:(NSError **)errPtr;
- (BOOL) createStreamsToHost:(NSString *)hostname onPort:(UInt16)port error:(NSError **)errPtr;
- (NSData *) sockaddrFromString:(NSString *)addrStr port:(UInt16)port error:(NSError **)errPtr;
- (BOOL) setSocketFromStreamsAndReturnError:(NSError **)errPtr;
- (CFSocketRef) createAcceptSocketForAddress:(NSData *)addr error:(NSError **)errPtr;
- (void) attachAcceptSockets;
- (BOOL) attachStreamsToRunLoop:(NSRunLoop *)runLoop error:(NSError **)errPtr;
- (BOOL) configureStreamsAndReturnError:(NSError **)errPtr;
- (BOOL) openStreamsAndReturnError:(NSError **)errPtr;
- (void) doStreamOpen;
- (void) closeWithError:(NSError *)err;
- (void) recoverUnreadData;
- (void) emptyQueues;
- (void) close;
- (NSError *) getAbortError;
- (NSError *) getStreamError;
- (NSError *) getSocketError;
- (NSError *) getReadTimeoutError;
- (NSError *) getWriteTimeoutError;
- (NSError *) errorFromCFStreamError:(CFStreamError)err;
- (void) maybeScheduleDisconnect;
- (void) doBytesAvailable;
- (void) completeCurrentRead;
- (void) endCurrentRead;
- (void) scheduleDequeueRead;
- (void) maybeDequeueRead;
- (void) doReadTimeout:(NSTimer *)timer;
- (void) doSendBytes;
- (void) completeCurrentWrite;
- (void) endCurrentWrite;
- (void) scheduleDequeueWrite;
- (void) maybeDequeueWrite;
- (void) doWriteTimeout:(NSTimer *)timer;
- (void) doPoll:(NSTimer *)timer;
@end
static void MyCFSocketCallback (CFSocketRef, CFSocketCallBackType, CFDataRef, const void *, void *);
static void MyCFReadStreamCallback (CFReadStreamRef stream, CFStreamEventType type, void *pInfo);
static void MyCFWriteStreamCallback (CFWriteStreamRef stream, CFStreamEventType type, void *pInfo);
#pragma mark -
#pragma mark AsyncReadPacket
@interface AsyncReadPacket : NSObject
{
@public
NSMutableData *buffer;
CFIndex bytesDone;
NSTimeInterval timeout;
long tag;
NSData *term;
BOOL readAllAvailableData;
}
- (id)initWithData:(NSMutableData *)d timeout:(NSTimeInterval)t tag:(long)i readAllAvailable:(BOOL)a terminator:(NSData *)e bufferOffset:(CFIndex)b;
- (void)dealloc;
@end
@implementation AsyncReadPacket
- (id)initWithData:(NSMutableData *)d timeout:(NSTimeInterval)t tag:(long)i readAllAvailable:(BOOL)a terminator:(NSData *)e bufferOffset:(CFIndex)b
{
self = [super init];
buffer = [d retain];
timeout = t;
tag = i;
term = [e copy];
bytesDone = b;
readAllAvailableData = a;
return self;
}
- (void)dealloc
{
[buffer release];
[term release];
[super dealloc];
}
@end
#pragma mark -
#pragma mark AsyncWritePacket
@interface AsyncWritePacket : NSObject
{
@public
NSData *buffer;
CFIndex bytesDone;
long tag;
NSTimeInterval timeout;
}
- (id)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i;
- (void)dealloc;
@end
@implementation AsyncWritePacket
- (id)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i;
{
self = [super init];
buffer = [d retain];
timeout = t;
tag = i;
bytesDone = 0;
return self;
}
- (void)dealloc
{
[buffer release];
[super dealloc];
}
@end
@implementation AsyncSocket
@synthesize mc_vi;
@synthesize mc_dataMode;
@synthesize mc_size;
#pragma mark -
#pragma mark Initialization
- (id) init
{
return [self initWithDelegate:nil userData:0];
}
- (id) initWithDelegate:(id)delegate
{
return [self initWithDelegate:delegate userData:0];
}
// Designated initializer.
- (id) initWithDelegate:(id)delegate userData:(long)userData
{
self = [super init];
mc_dataMode = NO;
theFlags = 0x00;
theDelegate = delegate;
theUserData = userData;
thePollTimer = nil;
theSocket = NULL;
theSource = NULL;
theSocket6 = NULL;
theSource6 = NULL;
theRunLoop = NULL;
theReadStream = NULL;
theWriteStream = NULL;
theReadQueue = [[NSMutableArray alloc] initWithCapacity:READQUEUE_CAPACITY];
theCurrentRead = nil;
theReadTimer = nil;
partialReadBuffer = nil;
theWriteQueue = [[NSMutableArray alloc] initWithCapacity:WRITEQUEUE_CAPACITY];
theCurrentWrite = nil;
theWriteTimer = nil;
// Socket context
NSAssert (sizeof(CFSocketContext) == sizeof(CFStreamClientContext), @"CFSocketContext and CFStreamClientContext aren't the same size anymore. Contact the developer.");
theContext.version = 0;
theContext.info = self;
theContext.retain = nil;
theContext.release = nil;
theContext.copyDescription = nil;
return self;
}
// The socket may been initialized in a connected state and auto-released, so this should close it down cleanly.
- (void) dealloc
{
[self close];
[theReadQueue release];
[theWriteQueue release];
[NSObject cancelPreviousPerformRequestsWithTarget: theDelegate selector: @selector(onSocketDidDisconnect:) object:self];
[NSObject cancelPreviousPerformRequestsWithTarget: self];
[super dealloc];
}
#pragma mark -
#pragma mark Accessors
- (long) userData
{
return theUserData;
}
- (void) setUserData:(long)userData
{
theUserData = userData;
}
- (id) delegate
{
return theDelegate;
}
- (void) setDelegate:(id)delegate
{
theDelegate = delegate;
}
- (BOOL) canSafelySetDelegate
{
return ([theReadQueue count] == 0 && [theWriteQueue count] == 0 && theCurrentRead == nil && theCurrentWrite == nil);
}
- (CFSocketRef) getCFSocket
{
return theSocket;
}
- (CFReadStreamRef) getCFReadStream
{
return theReadStream;
}
- (CFWriteStreamRef) getCFWriteStream
{
return theWriteStream;
}
- (float) progressOfReadReturningTag:(long *)tag bytesDone:(CFIndex *)done total:(CFIndex *)total
{
if (!theCurrentRead) return NAN;
BOOL hasTotal = (theCurrentRead->readAllAvailableData == NO &&
theCurrentRead->term == nil);
CFIndex d = theCurrentRead->bytesDone;
CFIndex t = hasTotal ? [theCurrentRead->buffer length] : 0;
if (tag != NULL) *tag = theCurrentRead->tag;
if (done != NULL) *done = d;
if (total != NULL) *total = t;
float ratio = (float)d/(float)t;
return isnan(ratio) ? 1.0 : ratio; // 0 of 0 bytes is 100% done.
}
- (float) progressOfWriteReturningTag:(long *)tag bytesDone:(CFIndex *)done total:(CFIndex *)total
{
if (!theCurrentWrite) return NAN;
CFIndex d = theCurrentWrite->bytesDone;
CFIndex t = [theCurrentWrite->buffer length];
if (tag != NULL) *tag = theCurrentWrite->tag;
if (done != NULL) *done = d;
if (total != NULL) *total = t;
return (float)d/(float)t;
}
#pragma mark -
#pragma mark Class Methods
// Return line separators.
+ (NSData *) CRLFData
{
return [NSData dataWithBytes:"\x0D\x0A" length:2];
}
+ (NSData *) CRData
{
return [NSData dataWithBytes:"\x0D" length:1];
}
+ (NSData *) LFData
{
return [NSData dataWithBytes:"\x0A" length:1];
}
+ (NSData *) ZeroData
{
return [NSData dataWithBytes:"" length:1];
}
#pragma mark -
#pragma mark Connection
- (BOOL) acceptOnPort:(UInt16)port error:(NSError **)errPtr
{
return [self acceptOnAddress:nil port:port error:errPtr];
}
// Setting up IPv4 and IPv6 accepting sockets.
- (BOOL) acceptOnAddress:(NSString *)hostaddr port:(UInt16)port error:(NSError **)errPtr
{
if (theDelegate == NULL)
[NSException raise:AsyncSocketException format:@"Attempting to accept without a delegate. Set a delegate first."];
if (theSocket != NULL || theSocket6 != NULL)
[NSException raise:AsyncSocketException format:@"Attempting to accept while connected or accepting connections. Disconnect first."];
// Set up the listen sockaddr structs if needed.
NSData *address = nil, *address6 = nil;
if (hostaddr != nil && [hostaddr length] != 0)
{
address = [self sockaddrFromString:hostaddr port:port error:errPtr];
if (!address) return NO;
}
else
{
// Set up the addresses.
struct sockaddr_in nativeAddr =
{
/*sin_len*/ sizeof(struct sockaddr_in),
/*sin_family*/ AF_INET,
/*sin_port*/ htons (port),
/*sin_addr*/ { htonl (INADDR_ANY) },
/*sin_zero*/ { 0 }
};
struct sockaddr_in6 nativeAddr6 =
{
/*sin6_len*/ sizeof(struct sockaddr_in6),
/*sin6_family*/ AF_INET6,
/*sin6_port*/ htons (port),
/*sin6_flowinfo*/ 0,
/*sin6_addr*/ in6addr_any,
/*sin6_scope_id*/ 0
};
// Wrap the native address structures for CFSocketSetAddress.
address = [NSData dataWithBytesNoCopy:&nativeAddr length:sizeof(nativeAddr) freeWhenDone:NO];
address6 = [NSData dataWithBytesNoCopy:&nativeAddr6 length:sizeof(nativeAddr6) freeWhenDone:NO];
}
// Create the sockets.
if (address)
{
theSocket = [self createAcceptSocketForAddress:address error:errPtr];
if (theSocket == NULL) goto Failed;
}
if (address6)
{
theSocket6 = [self createAcceptSocketForAddress:address6 error:errPtr];
if (theSocket6 == NULL) goto Failed;
}
[self attachAcceptSockets];
// Set the SO_REUSEADDR flags.
int reuseOn = 1;
if (theSocket) setsockopt (CFSocketGetNative(theSocket), SOL_SOCKET, SO_REUSEADDR, &reuseOn, sizeof(reuseOn));
if (theSocket6) setsockopt (CFSocketGetNative(theSocket6), SOL_SOCKET, SO_REUSEADDR, &reuseOn, sizeof(reuseOn));
// Set the local bindings which causes the sockets to start listening.
CFSocketError err;
if (theSocket)
{
err = CFSocketSetAddress (theSocket, (CFDataRef)address);
if (err != kCFSocketSuccess) goto Failed;
}
if (theSocket6)
{
err = CFSocketSetAddress (theSocket6, (CFDataRef)address6);
if (err != kCFSocketSuccess) goto Failed;
}
theFlags |= kDidPassConnectMethod;
return YES;
Failed:;
if (errPtr) *errPtr = [self getSocketError];
return NO;
}
- (BOOL) connectToHost:(NSString*)hostname onPort:(UInt16)port error:(NSError **)errPtr
{
if (theDelegate == NULL)
[NSException raise:AsyncSocketException format:@"Attempting to connect without a delegate. Set a delegate first."];
if (theSocket != NULL || theSocket6 != NULL)
[NSException raise:AsyncSocketException format:@"Attempting to connect while connected or accepting connections. Disconnect first."];
if (![self createStreamsToHost:hostname onPort:port error:errPtr]) goto Failed;
if (![self attachStreamsToRunLoop:nil error:errPtr]) goto Failed;
if (![self configureStreamsAndReturnError:errPtr]) goto Failed;
if (![self openStreamsAndReturnError:errPtr]) goto Failed;
theFlags |= kDidPassConnectMethod;
return YES;
Failed:;
[self close];
return NO;
}
- (void) disconnect
{
[self close];
}
- (void) disconnectAfterWriting
{
theFlags |= kForbidReadsWrites;
theFlags |= kDisconnectSoon;
[self maybeScheduleDisconnect];
}
#pragma mark -
#pragma mark Accept Impl.
- (NSData *) sockaddrFromString:(NSString *)addrStr port:(UInt16)port error:(NSError **)errPtr
{
NSData *resultData = nil;
struct addrinfo hints = {0}, *result;
hints.ai_family = PF_UNSPEC;
hints.ai_socktype = SOCK_STREAM;
hints.ai_protocol = IPPROTO_TCP;
hints.ai_flags = AI_NUMERICHOST | AI_PASSIVE;
@synchronized (getaddrinfoLock)
{
NSData *addrStrData = [addrStr dataUsingEncoding:NSASCIIStringEncoding
allowLossyConversion:YES];
char portStr[] = "65535"; // Reserve space for max port number.
snprintf(portStr, sizeof(portStr), "%u", port);
int err = getaddrinfo ([addrStrData bytes], portStr,
(const struct addrinfo *)&hints,
(struct addrinfo **)&result);
if (!err)
{
resultData = [NSData dataWithBytes:result->ai_addr
length:result->ai_addrlen];
freeaddrinfo (result);
}
else if (errPtr)
{
NSString *errMsg = [NSString stringWithCString: gai_strerror(err)
encoding: NSASCIIStringEncoding];
NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:
errMsg, NSLocalizedDescriptionKey, nil];
*errPtr = [NSError errorWithDomain:@"kCFStreamErrorDomainNetDB"
code:err
userInfo:info];
}
}
return resultData;
}
// Creates the accept sockets. Returns true if either IPv4 or IPv6 is created. If either is missing, an error is returned (even though the method may return true).
- (CFSocketRef) createAcceptSocketForAddress:(NSData *)addr error:(NSError **)errPtr
{
struct sockaddr *pSockAddr = (struct sockaddr *)[addr bytes];
int addressFamily = pSockAddr->sa_family;
CFSocketRef socket = CFSocketCreate (kCFAllocatorDefault, addressFamily, SOCK_STREAM, 0, kCFSocketAcceptCallBack, (CFSocketCallBack)&MyCFSocketCallback, &theContext);
if (socket == NULL && errPtr)
*errPtr = [self getSocketError];
return socket;
}
// Adds the sockets to the run-loop.
- (void) attachAcceptSockets
{
theRunLoop = CFRunLoopGetCurrent();
if (theSocket)
{
theSource = CFSocketCreateRunLoopSource (kCFAllocatorDefault, theSocket, 0);
CFRunLoopAddSource (theRunLoop, theSource, kCFRunLoopDefaultMode);
}
if (theSocket6)
{
theSource6 = CFSocketCreateRunLoopSource (kCFAllocatorDefault, theSocket6, 0);
CFRunLoopAddSource (theRunLoop, theSource6, kCFRunLoopDefaultMode);
}
}
// If I can't make the new socket, ignore this event.
- (void) doAcceptWithSocket:(CFSocketNativeHandle)newNative
{
AsyncSocket *newSocket = [[[AsyncSocket alloc] initWithDelegate:theDelegate] autorelease];
if (newSocket != nil)
{
NSRunLoop *runLoop = nil;
if ([theDelegate respondsToSelector:@selector(onSocket:didAcceptNewSocket:)])
[theDelegate onSocket:self didAcceptNewSocket:newSocket];
if ([theDelegate respondsToSelector:@selector(onSocket:wantsRunLoopForNewSocket:)])
runLoop = [theDelegate onSocket:self wantsRunLoopForNewSocket:newSocket];
if (![newSocket createStreamsFromNative:newNative error:nil]) goto Failed;
if (![newSocket attachStreamsToRunLoop:runLoop error:nil]) goto Failed;
if (![newSocket configureStreamsAndReturnError:nil]) goto Failed;
if (![newSocket openStreamsAndReturnError:nil]) goto Failed;
newSocket->theFlags |= kDidPassConnectMethod;
}
return;
Failed:;
// No NSError, but errors will still get logged from the above functions.
[newSocket close];
return;
}
#pragma mark -
#pragma mark Connect Impl.
// Creates the socket from a native socket.
- (BOOL) createStreamsFromNative:(CFSocketNativeHandle)native error:(NSError **)errPtr
{
// Create the socket & streams.
CFStreamCreatePairWithSocket (kCFAllocatorDefault, native, &theReadStream, &theWriteStream);
if (theReadStream == NULL || theWriteStream == NULL)
{
NSError *err = [self getStreamError];
NSLog (@"AsyncSocket %p couldn't create streams from accepted socket, %@", self, err);
if (errPtr) *errPtr = err;
return NO;
}
return YES;
}
- (BOOL) createStreamsToHost:(NSString *)hostname onPort:(UInt16)port error:(NSError **)errPtr
{
// Create the socket & streams.
CFStreamCreatePairWithSocketToHost (kCFAllocatorDefault, (CFStringRef)hostname, port, &theReadStream, &theWriteStream);
if (theReadStream == NULL || theWriteStream == NULL)
{
if (errPtr) *errPtr = [self getStreamError];
return NO;
}
return YES;
}
- (BOOL) attachStreamsToRunLoop:(NSRunLoop *)runLoop error:(NSError **)errPtr
{
// Get the CFRunLoop to which the socket should be attached.
theRunLoop = (runLoop == nil) ? CFRunLoopGetCurrent() : [runLoop getCFRunLoop];
// Make read stream non-blocking.
if (!CFReadStreamSetClient (theReadStream,
kCFStreamEventHasBytesAvailable | kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered | kCFStreamEventOpenCompleted,
(CFReadStreamClientCallBack)&MyCFReadStreamCallback,
(CFStreamClientContext *)(&theContext) ))
{
NSLog (@"AsyncSocket %p couldn't attach read stream to run-loop,", self);
goto Failed;
}
CFReadStreamScheduleWithRunLoop (theReadStream, theRunLoop, kCFRunLoopDefaultMode);
// Make write stream non-blocking.
if (!CFWriteStreamSetClient (theWriteStream,
kCFStreamEventCanAcceptBytes | kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered | kCFStreamEventOpenCompleted,
(CFWriteStreamClientCallBack)&MyCFWriteStreamCallback,
(CFStreamClientContext *)(&theContext) ))
{
NSLog (@"AsyncSocket %p couldn't attach write stream to run-loop,", self);
goto Failed;
}
CFWriteStreamScheduleWithRunLoop (theWriteStream, theRunLoop, kCFRunLoopDefaultMode);
return YES;
Failed:;
NSError *err = [self getStreamError];
NSLog (@"%@", err);
if (errPtr) *errPtr = err;
return NO;
}
- (BOOL) configureStreamsAndReturnError:(NSError **)errPtr
{
// Ensure the CF & BSD socket is closed when the streams are closed.
CFReadStreamSetProperty(theReadStream, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanTrue);
CFWriteStreamSetProperty(theWriteStream, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanTrue);
// Call the delegate method for further configuration.
if ([theDelegate respondsToSelector:@selector(onSocketWillConnect:)])
if ([theDelegate onSocketWillConnect:self] == NO)
goto Aborted;
return YES;
Aborted:;
NSError *err = [self getAbortError];
if (errPtr) *errPtr = err;
return NO;
};
- (BOOL) openStreamsAndReturnError:(NSError **)errPtr
{
if (!CFReadStreamOpen (theReadStream))
{
NSLog (@"AsyncSocket %p couldn't open read stream,", self);
goto Failed;
}
if (!CFWriteStreamOpen (theWriteStream))
{
NSLog (@"AsyncSocket %p couldn't open write stream,", self);
goto Failed;
}
return YES;
Failed:;
NSError *err = [self getStreamError];
NSLog (@"%@", err);
if (errPtr) *errPtr = err;
return NO;
}
// Called when read or write streams open. When the socket is connected and both streams are open, consider the AsyncSocket instance to be ready.
- (void) doStreamOpen
{
NSError *err = nil;
if ([self areStreamsConnected] && !(theFlags & kDidCallConnectDeleg))
{
// Get the socket.
if (![self setSocketFromStreamsAndReturnError: &err])
{
NSLog (@"AsyncSocket %p couldn't get socket from streams, %@. Disconnecting.", self, err);
[self closeWithError:err];
}
// Schedule a poll timer to make up for lost ready-to-read/write notifications. This doesn't have to have a tight poll interval, since it is a backup system.
thePollTimer = [NSTimer scheduledTimerWithTimeInterval:POLL_INTERVAL target:self selector:@selector(doPoll:) userInfo:nil repeats:YES];
// Call the delegate.
CFDataRef peer = CFSocketCopyPeerAddress (theSocket);
theFlags |= kDidCallConnectDeleg;
if ([theDelegate respondsToSelector:@selector(onSocket:didConnectToHost:port:)])
[theDelegate onSocket:self
didConnectToHost:[self addressHost:peer]
port:[self addressPort:peer]];
CFRelease (peer);
// Immediately deal with any already-queued requests.
[self maybeDequeueRead];
[self maybeDequeueWrite];
}
}
- (BOOL) setSocketFromStreamsAndReturnError:(NSError **)errPtr
{
CFSocketNativeHandle native;
CFDataRef nativeProp = CFReadStreamCopyProperty (theReadStream, kCFStreamPropertySocketNativeHandle);
if (nativeProp == NULL)
{
if (errPtr) *errPtr = [self getStreamError];
goto Failed;
}
CFDataGetBytes (nativeProp, CFRangeMake(0, CFDataGetLength(nativeProp)), (UInt8 *)&native);
CFRelease (nativeProp);
theSocket = CFSocketCreateWithNative (kCFAllocatorDefault, native, 0, NULL, NULL);
if (theSocket == NULL)
{
if (errPtr) *errPtr = [self getSocketError];
goto Failed;
}
return YES;
Failed:;
return NO;
}
#pragma mark -
#pragma mark Disconnect Impl.
// Sends error message and disconnects.
- (void) closeWithError:(NSError *)err
{
if (theFlags & kDidPassConnectMethod)
{
// Try to salvage what data we can.
[self recoverUnreadData];
// Let the delegate know, so it can try to recover if it likes.
if ([theDelegate respondsToSelector:@selector(onSocket:willDisconnectWithError:)])
[theDelegate onSocket:self willDisconnectWithError:err];
}
[self close];
}
// Prepare partially read data for recovery.
- (void) recoverUnreadData
{
if (theCurrentRead) [theCurrentRead->buffer setLength: theCurrentRead->bytesDone];
partialReadBuffer = (theCurrentRead ? [theCurrentRead->buffer copy] : nil);
[self emptyQueues];
}
- (void) emptyQueues
{
if (theCurrentRead != nil) [self endCurrentRead];
if (theCurrentWrite != nil) [self endCurrentWrite];
[theReadQueue removeAllObjects];
[theWriteQueue removeAllObjects];
[NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(maybeDequeueRead) object:nil];
[NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(maybeDequeueWrite) object:nil];
}
// Disconnects. This is called for both error and clean disconnections.
- (void) close
{
// Stop polling.
[thePollTimer invalidate];
thePollTimer = nil;
// Empty queues.
[self emptyQueues];
[partialReadBuffer release];
partialReadBuffer = nil;
[NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(disconnect) object:nil];
// Close streams.
if (theReadStream != NULL)
{
CFReadStreamUnscheduleFromRunLoop (theReadStream, theRunLoop, kCFRunLoopDefaultMode);
CFReadStreamClose (theReadStream);
CFRelease (theReadStream);
theReadStream = NULL;
}
if (theWriteStream != NULL)
{
CFWriteStreamUnscheduleFromRunLoop (theWriteStream, theRunLoop, kCFRunLoopDefaultMode);
CFWriteStreamClose (theWriteStream);
CFRelease (theWriteStream);
theWriteStream = NULL;
}
// Close sockets.
if (theSocket != NULL)
{
CFSocketInvalidate (theSocket);
CFRelease (theSocket);
theSocket = NULL;
}
if (theSocket6 != NULL)
{
CFSocketInvalidate (theSocket6);
CFRelease (theSocket6);
theSocket6 = NULL;
}
if (theSource != NULL)
{
CFRunLoopRemoveSource (theRunLoop, theSource, kCFRunLoopDefaultMode);
CFRelease (theSource);
theSource = NULL;
}
if (theSource6 != NULL)
{
CFRunLoopRemoveSource (theRunLoop, theSource6, kCFRunLoopDefaultMode);
CFRelease (theSource6);
theSource6 = NULL;
}
theRunLoop = NULL;
// If the client has passed the connect/accept method, then the connection has at least begun. Notify delegate that it is now ending.
if (theFlags & kDidPassConnectMethod)
{
// Delay notification to give him freedom to release without returning here and core-dumping.
if ([theDelegate respondsToSelector: @selector(onSocketDidDisconnect:)])
[theDelegate performSelector:@selector(onSocketDidDisconnect:) withObject:self afterDelay:0];
}
// Clear flags.
theFlags = 0x00;
}
#pragma mark -
#pragma mark Errors
- (NSError *) getStreamError
{
CFStreamError err;
if (theReadStream != NULL)
{
err = CFReadStreamGetError (theReadStream);
if (err.error != 0) return [self errorFromCFStreamError: err];
}
if (theWriteStream != NULL)
{
err = CFWriteStreamGetError (theWriteStream);
if (err.error != 0) return [self errorFromCFStreamError: err];
}
return nil;
}
// Unfortunately, CFSocket offers no feedback on its errors.
- (NSError *) getSocketError
{
NSString *errMsg = NSLocalizedStringWithDefaultValue
(@"AsyncSocketCFSocketError", @"AsyncSocket", [NSBundle mainBundle],
@"General CFSocket error", nil);
NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:
errMsg, NSLocalizedDescriptionKey, nil];
return [NSError errorWithDomain: AsyncSocketErrorDomain
code: AsyncSocketCFSocketError
userInfo: info];
}
- (NSError *) getAbortError
{
NSString *errMsg = NSLocalizedStringWithDefaultValue
(@"AsyncSocketCanceledError", @"AsyncSocket", [NSBundle mainBundle],
@"Connection canceled", nil);
NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:
errMsg, NSLocalizedDescriptionKey, nil];
return [NSError errorWithDomain: AsyncSocketErrorDomain
code: AsyncSocketCanceledError
userInfo: info];
}
- (NSError *) getReadTimeoutError
{
NSString *errMsg = NSLocalizedStringWithDefaultValue
(@"AsyncSocketReadTimeoutError", @"AsyncSocket", [NSBundle mainBundle],
@"Read operation timed out", nil);
NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:
errMsg, NSLocalizedDescriptionKey, nil];
return [NSError errorWithDomain: AsyncSocketErrorDomain
code: AsyncSocketReadTimeoutError
userInfo: info];
}
- (NSError *) getWriteTimeoutError
{
NSString *errMsg = NSLocalizedStringWithDefaultValue
(@"AsyncSocketWriteTimeoutError", @"AsyncSocket", [NSBundle mainBundle],
@"Write operation timed out", nil);
NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:
errMsg, NSLocalizedDescriptionKey, nil];
return [NSError errorWithDomain: AsyncSocketErrorDomain
code: AsyncSocketWriteTimeoutError
userInfo: info];
}
- (NSError *) errorFromCFStreamError:(CFStreamError)err
{
if (err.domain == 0 && err.error == 0) return nil;
// Can't use switch; these constants aren't int literals.
NSString *domain = @"CFStreamError (unlisted domain)";
NSString *message = nil;
if (err.domain == kCFStreamErrorDomainPOSIX)
domain = NSPOSIXErrorDomain;
else if (err.domain == kCFStreamErrorDomainMacOSStatus)
domain = NSOSStatusErrorDomain;
else if (err.domain == kCFStreamErrorDomainMach)
domain = NSMachErrorDomain;
else if (err.domain == kCFStreamErrorDomainNetDB)
{
domain = @"kCFStreamErrorDomainNetDB";
message = [NSString stringWithCString: gai_strerror(err.error)
encoding: NSASCIIStringEncoding];
}
else if (err.domain == kCFStreamErrorDomainNetServices)
domain = @"kCFStreamErrorDomainNetServices";
else if (err.domain == kCFStreamErrorDomainSOCKS)
domain = @"kCFStreamErrorDomainSOCKS";
else if (err.domain == kCFStreamErrorDomainSystemConfiguration)
domain = @"kCFStreamErrorDomainSystemConfiguration";
else if (err.domain == kCFStreamErrorDomainSSL)
domain = @"kCFStreamErrorDomainSSL";
NSDictionary *info = nil;
if (message != nil)
{
info = [NSDictionary dictionaryWithObjectsAndKeys:
message, NSLocalizedDescriptionKey, nil];
}
return [NSError errorWithDomain:domain code:err.error userInfo:info];
}
#pragma mark -
#pragma mark Diagnostics
- (BOOL) isConnected
{
return [self isSocketConnected] && [self areStreamsConnected];
}
- (NSString *) connectedHost
{
return [self connectedHost:theSocket];
}
- (UInt16) connectedPort
{
return [self connectedPort:theSocket];
}
- (NSString *) localHost
{
return [self localHost:theSocket];
}
- (UInt16) localPort
{
return [self localPort:theSocket];
}
- (NSString *) connectedHost: (CFSocketRef)socket
{
if (socket == NULL) return nil;
CFDataRef peeraddr;
NSString *peerstr = nil;
if (socket && (peeraddr = CFSocketCopyPeerAddress (socket)))
{
peerstr = [self addressHost:peeraddr];
CFRelease (peeraddr);
}
return peerstr;
}
- (UInt16) connectedPort: (CFSocketRef)socket
{
if (socket == NULL) return 0;
CFDataRef peeraddr;
UInt16 peerport = 0;
if (socket && (peeraddr = CFSocketCopyPeerAddress (socket)))
{
peerport = [self addressPort:peeraddr];
CFRelease (peeraddr);
}
return peerport;
}