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  import io.netty.channel.AddressedEnvelope;
20  import io.netty.channel.ChannelHandler;
21  import io.netty.channel.ChannelHandlerContext;
22  import io.netty.channel.socket.DatagramPacket;
23  import io.netty.handler.codec.MessageToMessageEncoder;
24  
25  import java.net.InetSocketAddress;
26  import java.util.List;
27  
28  /**
29   * Encodes a {@link DatagramDnsQuery} (or an {@link AddressedEnvelope} of {@link DnsQuery}} into a
30   * {@link DatagramPacket}.
31   */
32  @ChannelHandler.Sharable
33  public class DatagramDnsQueryEncoder extends MessageToMessageEncoder<AddressedEnvelope<DnsQuery, InetSocketAddress>> {
34  
35      private final DnsQueryEncoder encoder;
36  
37      /**
38       * Creates a new encoder with {@linkplain DnsRecordEncoder#DEFAULT the default record encoder}.
39       */
40      public DatagramDnsQueryEncoder() {
41          this(DnsRecordEncoder.DEFAULT);
42      }
43  
44      /**
45       * Creates a new encoder with the specified {@code recordEncoder}.
46       */
47      public DatagramDnsQueryEncoder(DnsRecordEncoder recordEncoder) {
48          this.encoder = new DnsQueryEncoder(recordEncoder);
49      }
50  
51      @Override
52      protected void encode(
53          ChannelHandlerContext ctx,
54          AddressedEnvelope<DnsQuery, InetSocketAddress> in, List<Object> out) throws Exception {
55  
56          final InetSocketAddress recipient = in.recipient();
57          final DnsQuery query = in.content();
58          final ByteBuf buf = allocateBuffer(ctx, in);
59  
60          boolean success = false;
61          try {
62              encoder.encode(query, buf);
63              success = true;
64          } finally {
65              if (!success) {
66                  buf.release();
67              }
68          }
69  
70          out.add(new DatagramPacket(buf, recipient, null));
71      }
72  
73      /**
74       * Allocate a {@link ByteBuf} which will be used for constructing a datagram packet.
75       * Sub-classes may override this method to return a {@link ByteBuf} with a perfect matching initial capacity.
76       */
77      protected ByteBuf allocateBuffer(
78          ChannelHandlerContext ctx,
79          @SuppressWarnings("unused") AddressedEnvelope<DnsQuery, InetSocketAddress> msg) throws Exception {
80          return ctx.alloc().ioBuffer(1024);
81      }
82  }