TCP/TCPListener.m
author Jens Alfke <jens@mooseyard.com>
Sun May 25 12:32:47 2008 -0700 (2008-05-25)
changeset 5 2c4bb6968927
parent 0 9d67172bb323
child 8 6f539dd9921c
permissions -rwxr-xr-x
More documentation.
jens@0
     1
//
jens@0
     2
//  TCPListener.m
jens@0
     3
//  MYNetwork
jens@0
     4
//
jens@0
     5
//  Created by Jens Alfke on 5/10/08.
jens@0
     6
//  Copyright 2008 Jens Alfke. All rights reserved.
jens@0
     7
//  Portions based on TCPServer class from Apple's "CocoaEcho" sample code.
jens@0
     8
jens@0
     9
#import "TCPListener.h"
jens@0
    10
#import "TCPConnection.h"
jens@0
    11
jens@1
    12
#import "Logging.h"
jens@1
    13
#import "Test.h"
jens@0
    14
#import "ExceptionUtils.h"
jens@0
    15
#import "IPAddress.h"
jens@1
    16
jens@0
    17
#include <sys/socket.h>
jens@0
    18
#include <netinet/in.h>
jens@0
    19
#include <unistd.h>
jens@0
    20
jens@0
    21
jens@0
    22
static void TCPListenerAcceptCallBack(CFSocketRef socket, CFSocketCallBackType type, 
jens@0
    23
                                      CFDataRef address, const void *data, void *info);
jens@0
    24
jens@0
    25
@interface TCPListener()
jens@0
    26
@property BOOL bonjourPublished;
jens@0
    27
@property NSInteger bonjourError;
jens@0
    28
- (void) _updateTXTRecord;
jens@0
    29
@end
jens@0
    30
jens@0
    31
jens@0
    32
@implementation TCPListener
jens@0
    33
jens@0
    34
jens@0
    35
- (id) initWithPort: (UInt16)port
jens@0
    36
{
jens@0
    37
    self = [super init];
jens@0
    38
    if (self != nil) {
jens@0
    39
        _port = port;
jens@0
    40
    }
jens@0
    41
    return self;
jens@0
    42
}
jens@0
    43
jens@0
    44
jens@0
    45
- (void) dealloc 
jens@0
    46
{
jens@0
    47
    [self close];
jens@0
    48
    LogTo(TCP,@"DEALLOC %@",self);
jens@0
    49
    [super dealloc];
jens@0
    50
}
jens@0
    51
jens@0
    52
jens@0
    53
@synthesize delegate=_delegate, port=_port, useIPv6=_useIPv6,
jens@0
    54
            bonjourServiceType=_bonjourServiceType, bonjourServiceName=_bonjourServiceName,
jens@0
    55
            bonjourPublished=_bonjourPublished, bonjourError=_bonjourError,
jens@0
    56
            pickAvailablePort=_pickAvailablePort;
jens@0
    57
jens@0
    58
jens@0
    59
- (NSString*) description
jens@0
    60
{
jens@0
    61
    return $sprintf(@"%@[port %hu]",self.class,_port);
jens@0
    62
}
jens@0
    63
jens@0
    64
jens@0
    65
// Stores the last error from CFSocketCreate or CFSocketSetAddress into *ouError.
jens@0
    66
static void* getLastCFSocketError( NSError **outError ) {
jens@0
    67
    if( outError )
jens@0
    68
        *outError = [NSError errorWithDomain: NSPOSIXErrorDomain code: errno userInfo: nil];
jens@0
    69
    return NULL;
jens@0
    70
}
jens@0
    71
jens@0
    72
// Closes a socket (if it's not already NULL), and returns NULL to assign to it.
jens@0
    73
static CFSocketRef closeSocket( CFSocketRef socket ) {
jens@0
    74
    if( socket ) {
jens@0
    75
        CFSocketInvalidate(socket);
jens@0
    76
        CFRelease(socket);
jens@0
    77
    }
jens@0
    78
    return NULL;
jens@0
    79
}
jens@0
    80
jens@0
    81
// opens a socket of a given protocol, either ipv4 or ipv6.
jens@0
    82
- (CFSocketRef) _openProtocol: (SInt32) protocolFamily 
jens@0
    83
                      address: (struct sockaddr*)address
jens@0
    84
                        error: (NSError**)error
jens@0
    85
{
jens@0
    86
    CFSocketContext socketCtxt = {0, self, NULL, NULL, NULL};
jens@0
    87
    CFSocketRef socket = CFSocketCreate(kCFAllocatorDefault, PF_INET, SOCK_STREAM, IPPROTO_TCP,
jens@0
    88
                                        kCFSocketAcceptCallBack, &TCPListenerAcceptCallBack, &socketCtxt);
jens@0
    89
    if( ! socket ) 
jens@0
    90
        return getLastCFSocketError(error);   // CFSocketCreate leaves error code in errno
jens@0
    91
    
jens@0
    92
    int yes = 1;
jens@0
    93
    setsockopt(CFSocketGetNative(socket), SOL_SOCKET, SO_REUSEADDR, (void *)&yes, sizeof(yes));
jens@0
    94
    
jens@0
    95
    NSData *addressData = [NSData dataWithBytes:address length:address->sa_len];
jens@0
    96
    if (kCFSocketSuccess != CFSocketSetAddress(socket, (CFDataRef)addressData)) {
jens@0
    97
        getLastCFSocketError(error);
jens@0
    98
        return closeSocket(socket);
jens@0
    99
    }
jens@0
   100
    // set up the run loop source for the socket
jens@0
   101
    CFRunLoopRef cfrl = CFRunLoopGetCurrent();
jens@0
   102
    CFRunLoopSourceRef source = CFSocketCreateRunLoopSource(kCFAllocatorDefault, socket, 0);
jens@0
   103
    CFRunLoopAddSource(cfrl, source, kCFRunLoopCommonModes);
jens@0
   104
    CFRelease(source);
jens@0
   105
    return socket;
jens@0
   106
}
jens@0
   107
jens@0
   108
- (BOOL) _failedToOpen: (NSError*)error
jens@0
   109
{
jens@0
   110
    LogTo(TCP,@"%@ failed to open: %@",self,error);
jens@0
   111
    [self tellDelegate: @selector(listener:failedToOpen:) withObject: error];
jens@0
   112
    return NO;
jens@0
   113
}
jens@0
   114
jens@0
   115
jens@0
   116
- (BOOL) open: (NSError**)outError 
jens@0
   117
{
jens@0
   118
    // set up the IPv4 endpoint; if port is 0, this will cause the kernel to choose a port for us
jens@0
   119
    do{
jens@0
   120
        struct sockaddr_in addr4;
jens@0
   121
        memset(&addr4, 0, sizeof(addr4));
jens@0
   122
        addr4.sin_len = sizeof(addr4);
jens@0
   123
        addr4.sin_family = AF_INET;
jens@0
   124
        addr4.sin_port = htons(_port);
jens@0
   125
        addr4.sin_addr.s_addr = htonl(INADDR_ANY);
jens@0
   126
jens@0
   127
        NSError *error;
jens@0
   128
        _ipv4socket = [self _openProtocol: PF_INET address: (struct sockaddr*)&addr4 error: &error];
jens@0
   129
        if( ! _ipv4socket ) {
jens@0
   130
            if( error.code==EADDRINUSE && _pickAvailablePort && _port<0xFFFF ) {
jens@0
   131
                LogTo(BLIPVerbose,@"%@: port busy, trying %hu...",self,_port+1);
jens@0
   132
                self.port++;        // try the next port
jens@0
   133
            } else {
jens@0
   134
                if( outError ) *outError = error;
jens@0
   135
                return [self _failedToOpen: error];
jens@0
   136
            }
jens@0
   137
        }
jens@0
   138
    }while( ! _ipv4socket );
jens@0
   139
    
jens@0
   140
    if (0 == _port) {
jens@0
   141
        // now that the binding was successful, we get the port number 
jens@0
   142
        NSData *addr = [(NSData *)CFSocketCopyAddress(_ipv4socket) autorelease];
jens@0
   143
        const struct sockaddr_in *addr4 = addr.bytes;
jens@0
   144
        self.port = ntohs(addr4->sin_port);
jens@0
   145
    }
jens@0
   146
    
jens@0
   147
    if( _useIPv6 ) {
jens@0
   148
        // set up the IPv6 endpoint
jens@0
   149
        struct sockaddr_in6 addr6;
jens@0
   150
        memset(&addr6, 0, sizeof(addr6));
jens@0
   151
        addr6.sin6_len = sizeof(addr6);
jens@0
   152
        addr6.sin6_family = AF_INET6;
jens@0
   153
        addr6.sin6_port = htons(_port);
jens@0
   154
        memcpy(&(addr6.sin6_addr), &in6addr_any, sizeof(addr6.sin6_addr));
jens@0
   155
        
jens@0
   156
        _ipv6socket = [self _openProtocol: PF_INET6 address: (struct sockaddr*)&addr6 error: outError];
jens@0
   157
        if( ! _ipv6socket ) {
jens@0
   158
            _ipv4socket = closeSocket(_ipv4socket);
jens@0
   159
            return [self _failedToOpen: *outError];
jens@0
   160
        }
jens@0
   161
    }
jens@0
   162
    
jens@0
   163
    // Open Bonjour:
jens@0
   164
    if( _bonjourServiceType && !_netService) {
jens@0
   165
        // instantiate the NSNetService object that will advertise on our behalf.
jens@0
   166
        _netService = [[NSNetService alloc] initWithDomain: @"local." 
jens@0
   167
                                                      type: _bonjourServiceType
jens@0
   168
                                                      name: _bonjourServiceName ?:@""
jens@0
   169
                                                      port: _port];
jens@0
   170
        if( _netService ) {
jens@0
   171
            [_netService setDelegate:self];
jens@0
   172
            if( _bonjourTXTRecord )
jens@0
   173
                [self _updateTXTRecord];
jens@0
   174
            [_netService publish];
jens@0
   175
        } else {
jens@0
   176
            self.bonjourError = -1;
jens@0
   177
            Warn(@"%@: Failed to create NSNetService",self);
jens@0
   178
        }
jens@0
   179
    }
jens@0
   180
jens@0
   181
    LogTo(TCP,@"%@ is open",self);
jens@0
   182
    [self tellDelegate: @selector(listenerDidOpen:) withObject: nil];
jens@0
   183
    return YES;
jens@0
   184
}
jens@0
   185
jens@0
   186
- (BOOL) open
jens@0
   187
{
jens@0
   188
    return [self open: nil];
jens@0
   189
}
jens@0
   190
    
jens@0
   191
jens@0
   192
- (void) close 
jens@0
   193
{
jens@0
   194
    if( _ipv4socket ) {
jens@0
   195
        if( _netService ) {
jens@0
   196
            [_netService stop];
jens@0
   197
            [_netService release];
jens@0
   198
            _netService = nil;
jens@0
   199
            self.bonjourPublished = NO;
jens@0
   200
        }
jens@0
   201
        self.bonjourError = 0;
jens@0
   202
jens@0
   203
        _ipv4socket = closeSocket(_ipv4socket);
jens@0
   204
        _ipv6socket = closeSocket(_ipv6socket);
jens@0
   205
jens@0
   206
        LogTo(BLIP,@"%@ is closed",self);
jens@0
   207
        [self tellDelegate: @selector(listenerDidClose:) withObject: nil];
jens@0
   208
    }
jens@0
   209
}
jens@0
   210
jens@0
   211
jens@0
   212
- (BOOL) isOpen
jens@0
   213
{
jens@0
   214
    return _ipv4socket != NULL;
jens@0
   215
}
jens@0
   216
jens@0
   217
jens@0
   218
#pragma mark -
jens@0
   219
#pragma mark ACCEPTING CONNECTIONS:
jens@0
   220
jens@0
   221
jens@0
   222
@synthesize connectionClass = _connectionClass;
jens@0
   223
jens@0
   224
jens@0
   225
- (BOOL) acceptConnection: (CFSocketNativeHandle)socket
jens@0
   226
{
jens@0
   227
    IPAddress *addr = [IPAddress addressOfSocket: socket];
jens@0
   228
    if( ! addr )
jens@0
   229
        return NO;
jens@0
   230
    if( [_delegate respondsToSelector: @selector(listener:shouldAcceptConnectionFrom:)]
jens@0
   231
       && ! [_delegate listener: self shouldAcceptConnectionFrom: addr] )
jens@0
   232
        return NO;
jens@0
   233
    
jens@0
   234
    Assert(_connectionClass);
jens@0
   235
    TCPConnection *conn = [[self.connectionClass alloc] initIncomingFromSocket: socket
jens@0
   236
                                                                      listener: self];
jens@0
   237
    if( ! conn )
jens@0
   238
        return NO;
jens@0
   239
    
jens@0
   240
    if( _sslProperties ) {
jens@0
   241
        conn.SSLProperties = _sslProperties;
jens@0
   242
        [conn setSSLProperty: $true forKey: (id)kCFStreamSSLIsServer];
jens@0
   243
    }
jens@0
   244
    [conn open];
jens@0
   245
    [self tellDelegate: @selector(listener:didAcceptConnection:) withObject: conn];
jens@0
   246
    return YES;
jens@0
   247
}
jens@0
   248
jens@0
   249
jens@0
   250
static void TCPListenerAcceptCallBack(CFSocketRef socket, CFSocketCallBackType type, CFDataRef address, const void *data, void *info) 
jens@0
   251
{
jens@0
   252
    TCPListener *server = (TCPListener *)info;
jens@0
   253
    if (kCFSocketAcceptCallBack == type) { 
jens@0
   254
        CFSocketNativeHandle nativeSocketHandle = *(CFSocketNativeHandle *)data;
jens@0
   255
        BOOL accepted = NO;
jens@0
   256
        @try{
jens@0
   257
            accepted = [server acceptConnection: nativeSocketHandle];
jens@0
   258
        }catchAndReport(@"TCPListenerAcceptCallBack");
jens@0
   259
        if( ! accepted )
jens@0
   260
            close(nativeSocketHandle);
jens@0
   261
    }
jens@0
   262
}
jens@0
   263
jens@0
   264
jens@0
   265
#pragma mark -
jens@0
   266
#pragma mark BONJOUR:
jens@0
   267
jens@0
   268
jens@0
   269
- (NSDictionary*) bonjourTXTRecord
jens@0
   270
{
jens@0
   271
    return _bonjourTXTRecord;
jens@0
   272
}
jens@0
   273
jens@0
   274
- (void) setBonjourTXTRecord: (NSDictionary*)txt
jens@0
   275
{
jens@0
   276
    if( ifSetObj(&_bonjourTXTRecord,txt) )
jens@0
   277
        [self _updateTXTRecord];
jens@0
   278
}
jens@0
   279
jens@0
   280
- (void) _updateTXTRecord
jens@0
   281
{
jens@0
   282
    if( _netService ) {
jens@0
   283
        NSData *data;
jens@0
   284
        if( _bonjourTXTRecord ) {
jens@0
   285
            data = [NSNetService dataFromTXTRecordDictionary: _bonjourTXTRecord];
jens@0
   286
            if( data )
jens@0
   287
                LogTo(BLIP,@"%@: Set %u-byte TXT record", self,data.length);
jens@0
   288
            else
jens@0
   289
                Warn(@"TCPListener: Couldn't convert txt dict to data: %@",_bonjourTXTRecord);
jens@0
   290
        } else
jens@0
   291
            data = nil;
jens@0
   292
        [_netService setTXTRecordData: data];
jens@0
   293
    }
jens@0
   294
}
jens@0
   295
jens@0
   296
jens@0
   297
- (void)netServiceWillPublish:(NSNetService *)sender
jens@0
   298
{
jens@0
   299
    LogTo(BLIP,@"%@: Advertising %@",self,sender);
jens@0
   300
    self.bonjourPublished = YES;
jens@0
   301
}
jens@0
   302
jens@0
   303
- (void)netService:(NSNetService *)sender didNotPublish:(NSDictionary *)errorDict
jens@0
   304
{
jens@0
   305
    self.bonjourError = [[errorDict objectForKey:NSNetServicesErrorCode] intValue];
jens@0
   306
    LogTo(BLIP,@"%@: Failed to advertise %@: error %i",self,sender,self.bonjourError);
jens@0
   307
    [_netService release];
jens@0
   308
    _netService = nil;
jens@0
   309
}
jens@0
   310
jens@0
   311
- (void)netServiceDidStop:(NSNetService *)sender
jens@0
   312
{
jens@0
   313
    LogTo(BLIP,@"%@: Stopped advertising %@",self,sender);
jens@0
   314
    self.bonjourPublished = NO;
jens@0
   315
    [_netService release];
jens@0
   316
    _netService = nil;
jens@0
   317
}
jens@0
   318
jens@0
   319
jens@0
   320
@end
jens@0
   321
jens@0
   322
jens@0
   323
jens@0
   324
/*
jens@0
   325
 Copyright (c) 2008, Jens Alfke <jens@mooseyard.com>. All rights reserved.
jens@0
   326
 
jens@0
   327
 Redistribution and use in source and binary forms, with or without modification, are permitted
jens@0
   328
 provided that the following conditions are met:
jens@0
   329
 
jens@0
   330
 * Redistributions of source code must retain the above copyright notice, this list of conditions
jens@0
   331
 and the following disclaimer.
jens@0
   332
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
jens@0
   333
 and the following disclaimer in the documentation and/or other materials provided with the
jens@0
   334
 distribution.
jens@0
   335
 
jens@0
   336
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
jens@0
   337
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
jens@0
   338
 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
jens@0
   339
 BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jens@0
   340
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
jens@0
   341
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
jens@0
   342
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
jens@0
   343
 THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jens@0
   344
 */