View Javadoc
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  
20  /**
21   * Encodes a {@link DnsRecord} into binary representation.
22   *
23   * @see DatagramDnsQueryEncoder
24   */
25  public interface DnsRecordEncoder {
26  
27      DnsRecordEncoder DEFAULT = new DefaultDnsRecordEncoder();
28  
29      /**
30       * Encodes a {@link DnsQuestion}.
31       *
32       * @param out the output buffer where the encoded question will be written to
33       */
34      void encodeQuestion(DnsQuestion question, ByteBuf out) throws Exception;
35  
36      /**
37       * Encodes a {@link DnsRecord}.
38       *
39       * @param out the output buffer where the encoded record will be written to
40       */
41      void encodeRecord(DnsRecord record, ByteBuf out) throws Exception;
42  }