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.netty5.handler.codec.dns;
17
18 import io.netty5.buffer.api.Buffer;
19 import io.netty5.buffer.api.BufferAllocator;
20 import io.netty5.util.internal.UnstableApi;
21
22 /**
23 * Decodes a DNS record into its object representation.
24 *
25 * @see DatagramDnsResponseDecoder
26 */
27 @UnstableApi
28 public interface DnsRecordDecoder {
29
30 DnsRecordDecoder DEFAULT = new DefaultDnsRecordDecoder();
31
32 /**
33 * Decodes a DNS question into its object representation.
34 *
35 * @param in the input buffer which contains a DNS question at its reader index
36 */
37 DnsQuestion decodeQuestion(Buffer in) throws Exception;
38
39 /**
40 * Decodes a DNS record into its object representation.
41 *
42 * @param allocator
43 * @param in the input buffer which contains a DNS record at its reader index
44 * @return the decoded record, or {@code null} if there are not enough data in the input buffer
45 */
46 <T extends DnsRecord> T decodeRecord(BufferAllocator allocator, Buffer in) throws Exception;
47 }