2 // MYBonjourRegistration.h
5 // Created by Jens Alfke on 4/27/09.
6 // Copyright 2009 Jens Alfke. All rights reserved.
9 #import "MYDNSService.h"
10 @class MYBonjourService;
13 /** Registers a local network service with Bonjour, so it can be browsed by other computers. */
14 @interface MYBonjourRegistration : MYDNSService
16 NSString *_name, *_type, *_domain;
20 NSMutableDictionary *_txtRecord;
22 struct _DNSRecordRef_t *_nullRecordReg;
25 /** Initializes a new registration.
26 If you're also browsing for the same service type, you should instead get an instance of this via
27 the MYBonjourBrowser's 'myRegistration' property -- that way the browser knows about the
28 registration and won't echo it back to you.
29 Either way, don't forget to call -start! */
30 - (id) initWithServiceType: (NSString*)serviceType port: (UInt16)port;
32 /** The name to register this service under.
33 This is often left nil, in which case the user's chosen "Computer Name" (from the Sharing system
34 pref pane) will be used.
35 This can only be set before calling -start! */
36 @property (copy) NSString *name;
38 /** The registration's service type. */
39 @property (readonly) NSString *type;
41 /** The registration's IP port number.
42 You'll need to set this if you got this object from MYBonjourBrowser's 'myRegistration' property,
43 as that object doesn't have a pre-set port number yet.
44 This can only be set before calling -start! */
45 @property UInt16 port;
47 /** The registration's full name -- the name, type and domain concatenated together. */
48 @property (readonly) NSString *fullName;
51 /** Is the registration currently active? */
52 @property (readonly) BOOL registered;
55 /** The service's metadata dictionary, stored in its DNS TXT record */
56 @property (copy) NSDictionary *TXTRecord;
58 /** Convenience to store a string value in a single TXT record key. */
59 - (void) setString: (NSString*)value forTXTKey: (NSString*)key;
63 * Advanced methods you likely won't need
67 /** The registration's domain name.
68 This is almost always left nil, in which case the default registration domain is used
70 This can only be set before calling -start! */
71 @property (copy) NSString *domain;
73 /** Determines what to do if there's a name conflict with an already-registered service on the
75 If set to YES (the default), a number will be appended to the name to make it unique.
76 If set to NO, the registration will fail, and you can choose a different name and try again.
77 This can only be set before calling -start! */
78 @property BOOL autoRename;
80 /** Is this browsed service an echo of this local registration? (Compares fullNames.) */
81 - (BOOL) isSameAsService: (MYBonjourService*)service;
83 /** Immediately broadcast the current TXT record. (Normally, there is a 0.1 second delay
84 after you make changes, in order to coalesce multiple changes.) */
85 - (void) updateTXTRecord;
87 /** Converts a TXT record dictionary to data in a consistent way.
88 This is used when signing (and verifying signatures of) TXT records. */
89 + (NSData*) canonicalFormOfTXTRecordDictionary: (NSDictionary*)txtDict;
91 /** A DNS 'NULL' record that can be used to publish other metadata about the service.
92 For example, iChat uses this to store the user's buddy icon.
93 As with all DNS records, try not to exceed 1500 bytes in size. */
94 @property (copy) NSData *nullRecord;