PortMapper/MYDNSService.h
author Jens Alfke <jens@mooseyard.com>
Wed Apr 29 13:29:31 2009 -0700 (2009-04-29)
changeset 31 1d6924779df7
parent 28 732576fa8a0d
child 32 b3254a2f6d6c
permissions -rw-r--r--
More work on Bonjour classes. They now support registering services.
jens@27
     1
//
jens@27
     2
//  MYDNSService.h
jens@27
     3
//  MYNetwork
jens@27
     4
//
jens@27
     5
//  Created by Jens Alfke on 4/23/09.
jens@27
     6
//  Copyright 2009 Jens Alfke. All rights reserved.
jens@27
     7
//
jens@27
     8
jens@27
     9
#import <Foundation/Foundation.h>
jens@27
    10
#import <CoreFoundation/CFSocket.h>
jens@31
    11
@class MYDNSConnection;
jens@27
    12
jens@27
    13
jens@27
    14
/** Abstract superclass for services based on DNSServiceRefs, such as MYPortMapper. */
jens@27
    15
@interface MYDNSService : NSObject
jens@27
    16
{
jens@27
    17
    @private
jens@31
    18
    BOOL _usePrivateConnection;
jens@31
    19
    MYDNSConnection *_connection;
jens@27
    20
    struct _DNSServiceRef_t *_serviceRef;
jens@27
    21
    CFSocketRef _socket;
jens@27
    22
    CFRunLoopSourceRef _socketSource;
jens@27
    23
    SInt32 _error;
jens@31
    24
    BOOL _continuous, _gotResponse;
jens@27
    25
}
jens@27
    26
jens@28
    27
/** If NO (the default), the service will stop after it gets a result.
jens@28
    28
    If YES, it will continue to run until stopped. */
jens@28
    29
@property BOOL continuous;
jens@28
    30
jens@27
    31
/** Starts the service.
jens@27
    32
    Returns immediately; you can find out when the service actually starts (or fails to)
jens@27
    33
    by observing the isOpen and error properties.
jens@27
    34
    It's very unlikely that this call itself will fail (return NO). If it does, it
jens@27
    35
    probably means that the mDNSResponder process isn't working. */
jens@28
    36
- (BOOL) start;
jens@27
    37
jens@28
    38
/** Stops the service. */
jens@28
    39
- (void) stop;
jens@27
    40
jens@27
    41
jens@27
    42
/** The error status, a DNSServiceErrorType enum; nonzero if something went wrong. 
jens@27
    43
    This property is KV observable. */
jens@28
    44
@property int32_t error;
jens@27
    45
jens@31
    46
jens@31
    47
/** Utility to construct a service's full name. */
jens@31
    48
+ (NSString*) fullNameOfService: (NSString*)serviceName
jens@31
    49
                         ofType: (NSString*)type
jens@31
    50
                       inDomain: (NSString*)domain;
jens@31
    51
jens@31
    52
jens@31
    53
jens@27
    54
// PROTECTED:
jens@27
    55
jens@31
    56
jens@31
    57
@property BOOL usePrivateConnection;
jens@31
    58
jens@27
    59
/** Subclass must implement this abstract method to create a new DNSServiceRef.
jens@27
    60
    This method is called by -open.
jens@31
    61
    The implementation MUST pass the given sdRefPtr directly to the DNSService function
jens@31
    62
    that creates the new ref, without setting it to NULL first.
jens@31
    63
    It MUST also set the kDNSServiceFlagsShareConnection flag. */
jens@31
    64
- (int32_t/*DNSServiceErrorType*/) createServiceRef: (struct _DNSServiceRef_t**)sdRefPtr;
jens@31
    65
jens@31
    66
/** Subclass's callback must call this method after doing its own work.
jens@31
    67
    This method will update the error state, and will stop the service if it's not set to be
jens@31
    68
    continuous. */
jens@31
    69
- (void) gotResponse: (int32_t/*DNSServiceErrorType*/)errorCode;
jens@27
    70
jens@28
    71
@property (readonly) struct _DNSServiceRef_t* serviceRef;
jens@28
    72
jens@28
    73
/** Same as -stop, but does not clear the error property.
jens@28
    74
    (The stop method actually calls this first.) */
jens@28
    75
- (void) cancel;
jens@28
    76
jens@28
    77
/** Block until a message is received from the daemon.
jens@28
    78
    This will cause the service's callback (defined by the subclass) to be invoked.
jens@28
    79
    @return  YES if a message is received, NO on error (or if the service isn't started) */
jens@28
    80
- (BOOL) waitForReply;
jens@27
    81
jens@31
    82
jens@27
    83
@end
jens@31
    84
jens@31
    85
jens@31
    86
jens@31
    87
jens@31
    88
@interface MYDNSConnection : NSObject
jens@31
    89
{
jens@31
    90
    struct _DNSServiceRef_t* _connectionRef;
jens@31
    91
    CFSocketRef _socket;
jens@31
    92
    CFRunLoopSourceRef _runLoopSource;
jens@31
    93
}
jens@31
    94
jens@31
    95
+ (MYDNSConnection*) sharedConnection;
jens@31
    96
- (id) initWithServiceRef: (struct _DNSServiceRef_t *)serviceRef;
jens@31
    97
@property (readonly) struct _DNSServiceRef_t* connectionRef;
jens@31
    98
- (BOOL) processResult;
jens@31
    99
- (void) close;
jens@31
   100
jens@31
   101
@end