]> git.saurik.com Git - apple/mdnsresponder.git/blob - mDNSShared/Java/DNSSDRegistration.java
mDNSResponder-108.tar.gz
[apple/mdnsresponder.git] / mDNSShared / Java / DNSSDRegistration.java
1 /*
2 * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22
23 Change History (most recent first):
24
25 $Log: DNSSDRegistration.java,v $
26 Revision 1.2 2004/12/11 03:01:00 rpantos
27 <rdar://problem/3907498> Java DNSRecord API should be cleaned up
28
29 Revision 1.1 2004/04/30 16:32:34 rpantos
30 First checked in.
31
32
33 This file declares the public interface to DNSSDRegistration, a DNSSDService
34 subclass that allows a client to control a service registration.
35 */
36
37
38 package com.apple.dnssd;
39
40
41 /** A tracking object for a registration created by {@link DNSSD#register}. */
42
43 public interface DNSSDRegistration extends DNSSDService
44 {
45 /** Get a reference to the primary TXT record of a registered service.<P>
46 The record can be updated by sending it an update() message.<P>
47
48 <P>
49 @return A {@link DNSRecord}.
50 If {@link DNSSDRegistration#stop} is called, the DNSRecord is also
51 invalidated and may not be used further.
52 */
53 DNSRecord getTXTRecord()
54 throws DNSSDException;
55
56 /** Add a record to a registered service.<P>
57 The name of the record will be the same as the registered service's name.<P>
58 The record can be updated or deregistered by sending it an update() or remove() message.<P>
59
60 @param flags
61 Currently unused, reserved for future use.
62 <P>
63 @param rrType
64 The type of the record (e.g. TXT, SRV, etc), as defined in nameser.h.
65 <P>
66 @param rData
67 The raw rdata to be contained in the added resource record.
68 <P>
69 @param ttl
70 The time to live of the resource record, in seconds.
71 <P>
72 @return A {@link DNSRecord} that may be passed to updateRecord() or removeRecord().
73 If {@link DNSSDRegistration#stop} is called, the DNSRecord is also
74 invalidated and may not be used further.
75 */
76 DNSRecord addRecord( int flags, int rrType, byte[] rData, int ttl)
77 throws DNSSDException;
78 }
79