View Javadoc
1   /*
2    * Copyright 2014 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.channel.epoll;
17  
18  import io.netty.channel.Channel;
19  import io.netty.channel.socket.InternetProtocolFamily;
20  import io.netty.channel.socket.ServerSocketChannel;
21  import io.netty.channel.socket.SocketProtocolFamily;
22  
23  import java.io.IOException;
24  import java.net.InetAddress;
25  import java.net.InetSocketAddress;
26  import java.net.SocketAddress;
27  import java.util.Collection;
28  import java.util.Collections;
29  import java.util.Map;
30  
31  import static io.netty.channel.epoll.LinuxSocket.newSocketStream;
32  import static io.netty.channel.epoll.Native.IS_SUPPORTING_TCP_FASTOPEN_SERVER;
33  import static io.netty.channel.unix.NativeInetAddress.address;
34  
35  /**
36   * {@link ServerSocketChannel} implementation that uses linux EPOLL Edge-Triggered Mode for
37   * maximal performance.
38   */
39  public final class EpollServerSocketChannel extends AbstractEpollServerChannel implements ServerSocketChannel {
40  
41      private final EpollServerSocketChannelConfig config;
42      private volatile Collection<InetAddress> tcpMd5SigAddresses = Collections.emptyList();
43  
44      public EpollServerSocketChannel() {
45          this((SocketProtocolFamily) null);
46      }
47  
48      /**
49       * @deprecated  use {@link EpollServerSocketChannel#EpollServerSocketChannel(SocketProtocolFamily)}
50       */
51      @Deprecated
52      public EpollServerSocketChannel(InternetProtocolFamily protocol) {
53          super(newSocketStream(protocol), false);
54          config = new EpollServerSocketChannelConfig(this);
55      }
56  
57      public EpollServerSocketChannel(SocketProtocolFamily protocol) {
58          super(newSocketStream(protocol), false);
59          config = new EpollServerSocketChannelConfig(this);
60      }
61  
62      public EpollServerSocketChannel(int fd) {
63          // Must call this constructor to ensure this object's local address is configured correctly.
64          // The local address can only be obtained from a Socket object.
65          this(new LinuxSocket(fd));
66      }
67  
68      EpollServerSocketChannel(LinuxSocket fd) {
69          super(fd);
70          config = new EpollServerSocketChannelConfig(this);
71      }
72  
73      EpollServerSocketChannel(LinuxSocket fd, boolean active) {
74          super(fd, active);
75          config = new EpollServerSocketChannelConfig(this);
76      }
77  
78      @Override
79      protected void doBind(SocketAddress localAddress) throws Exception {
80          super.doBind(localAddress);
81          final int tcpFastopen;
82          if (IS_SUPPORTING_TCP_FASTOPEN_SERVER && (tcpFastopen = config.getTcpFastopen()) > 0) {
83              socket.setTcpFastOpen(tcpFastopen);
84          }
85          socket.listen(config.getBacklog());
86          active = true;
87      }
88  
89      @Override
90      public InetSocketAddress remoteAddress() {
91          return (InetSocketAddress) super.remoteAddress();
92      }
93  
94      @Override
95      public InetSocketAddress localAddress() {
96          return (InetSocketAddress) super.localAddress();
97      }
98  
99      @Override
100     public EpollServerSocketChannelConfig config() {
101         return config;
102     }
103 
104     @Override
105     protected Channel newChildChannel(int fd, byte[] address, int offset, int len) throws Exception {
106         return new EpollSocketChannel(this, new LinuxSocket(fd), address(address, offset, len));
107     }
108 
109     Collection<InetAddress> tcpMd5SigAddresses() {
110         return tcpMd5SigAddresses;
111     }
112 
113     void setTcpMd5Sig(Map<InetAddress, byte[]> keys) throws IOException {
114         // Add synchronized as newTcpMp5Sigs might do multiple operations on the socket itself.
115         synchronized (this) {
116             tcpMd5SigAddresses = TcpMd5Util.newTcpMd5Sigs(this, tcpMd5SigAddresses, keys);
117         }
118     }
119 }