1 /*
2 * Copyright 2015 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.handler.codec.dns;
17
18 import io.netty.buffer.ByteBuf;
19 import io.netty.util.internal.UnstableApi;
20
21 /**
22 * Decodes a DNS record into its object representation.
23 *
24 * @see DatagramDnsResponseDecoder
25 */
26 @UnstableApi
27 public interface DnsRecordDecoder {
28
29 DnsRecordDecoder DEFAULT = new DefaultDnsRecordDecoder();
30
31 /**
32 * Decodes a DNS question into its object representation.
33 *
34 * @param in the input buffer which contains a DNS question at its reader index
35 */
36 DnsQuestion decodeQuestion(ByteBuf in) throws Exception;
37
38 /**
39 * Decodes a DNS record into its object representation.
40 *
41 * @param in the input buffer which contains a DNS record at its reader index
42 *
43 * @return the decoded record, or {@code null} if there are not enough data in the input buffer
44 */
45 <T extends DnsRecord> T decodeRecord(ByteBuf in) throws Exception;
46 }