2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowjava.protocol.impl.core;
11 import io.netty.bootstrap.ServerBootstrap;
12 import io.netty.buffer.PooledByteBufAllocator;
13 import io.netty.channel.ChannelFuture;
14 import io.netty.channel.ChannelOption;
15 import io.netty.channel.nio.NioEventLoopGroup;
16 import io.netty.channel.socket.ServerSocketChannel;
17 import io.netty.channel.socket.nio.NioServerSocketChannel;
18 import io.netty.handler.logging.LogLevel;
19 import io.netty.handler.logging.LoggingHandler;
20 import io.netty.util.concurrent.GenericFutureListener;
22 import io.netty.channel.epoll.Epoll;
23 import io.netty.channel.EventLoopGroup;
24 import io.netty.channel.epoll.EpollEventLoopGroup;
25 import io.netty.channel.epoll.EpollServerSocketChannel;
27 import java.net.InetAddress;
28 import java.net.InetSocketAddress;
30 import org.opendaylight.openflowjava.protocol.api.connection.ThreadConfiguration;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
34 import com.google.common.util.concurrent.ListenableFuture;
35 import com.google.common.util.concurrent.SettableFuture;
38 * Class implementing server over TCP / TLS for handling incoming connections.
40 * @author michal.polkorab
42 public class TcpHandler implements ServerFacade {
44 * High/low write watermarks, in KiB.
46 private static final int DEFAULT_WRITE_HIGH_WATERMARK = 64;
47 private static final int DEFAULT_WRITE_LOW_WATERMARK = 32;
49 * Write spin count. This tells netty to immediately retry a non-blocking
50 * write this many times before moving on to selecting.
52 private static final int DEFAULT_WRITE_SPIN_COUNT = 16;
54 private static final Logger LOG = LoggerFactory.getLogger(TcpHandler.class);
57 private String address;
58 private final InetAddress startupAddress;
59 private EventLoopGroup workerGroup;
60 private EventLoopGroup bossGroup;
61 private final SettableFuture<Boolean> isOnlineFuture;
62 private ThreadConfiguration threadConfig;
64 private TcpChannelInitializer channelInitializer;
66 private Class<? extends ServerSocketChannel> socketChannelClass;
69 * Constructor of TCPHandler that listens on selected port.
71 * @param port listening port of TCPHandler server
73 public TcpHandler(final int port) {
78 * Constructor of TCPHandler that listens on selected address and port.
79 * @param address listening address of TCPHandler server
80 * @param port listening port of TCPHandler server
82 public TcpHandler(final InetAddress address, final int port) {
84 this.startupAddress = address;
85 isOnlineFuture = SettableFuture.create();
89 * Starts server on selected port.
94 * We generally do not perform IO-unrelated tasks, so we want to have
95 * all outstanding tasks completed before the executing thread goes
98 * Any other setting means netty will measure the time it spent selecting
99 * and spend roughly proportional time executing tasks.
101 //workerGroup.setIoRatio(100);
103 final ChannelFuture f;
105 ServerBootstrap b = new ServerBootstrap();
106 b.group(bossGroup, workerGroup)
107 .channel(socketChannelClass)
108 .handler(new LoggingHandler(LogLevel.DEBUG))
109 .childHandler(channelInitializer)
110 .option(ChannelOption.SO_BACKLOG, 128)
111 .option(ChannelOption.SO_REUSEADDR, true)
112 .childOption(ChannelOption.SO_KEEPALIVE, true)
113 .childOption(ChannelOption.TCP_NODELAY , true)
114 .childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
115 .childOption(ChannelOption.WRITE_BUFFER_HIGH_WATER_MARK, DEFAULT_WRITE_HIGH_WATERMARK * 1024)
116 .childOption(ChannelOption.WRITE_BUFFER_LOW_WATER_MARK, DEFAULT_WRITE_LOW_WATERMARK * 1024)
117 .childOption(ChannelOption.WRITE_SPIN_COUNT, DEFAULT_WRITE_SPIN_COUNT);
119 if (startupAddress != null) {
120 f = b.bind(startupAddress.getHostAddress(), port).sync();
122 f = b.bind(port).sync();
124 } catch (InterruptedException e) {
125 LOG.error("Interrupted while binding port {}", port, e);
130 InetSocketAddress isa = (InetSocketAddress) f.channel().localAddress();
131 address = isa.getHostString();
133 // Update port, as it may have been specified as 0
134 this.port = isa.getPort();
136 LOG.debug("address from tcphandler: {}", address);
137 isOnlineFuture.set(true);
138 LOG.info("Switch listener started and ready to accept incoming tcp/tls connections on port: {}", port);
139 f.channel().closeFuture().sync();
140 } catch (InterruptedException e) {
141 LOG.error("Interrupted while waiting for port {} shutdown", port, e);
148 * Shuts down {@link TcpHandler}}
151 public ListenableFuture<Boolean> shutdown() {
152 final SettableFuture<Boolean> result = SettableFuture.create();
153 workerGroup.shutdownGracefully();
154 // boss will shutdown as soon, as worker is down
155 bossGroup.shutdownGracefully().addListener(new GenericFutureListener<io.netty.util.concurrent.Future<Object>>() {
158 public void operationComplete(
159 final io.netty.util.concurrent.Future<Object> downResult) throws Exception {
160 result.set(downResult.isSuccess());
161 if (downResult.cause() != null) {
162 result.setException(downResult.cause());
172 * @return number of connected clients / channels
174 public int getNumberOfConnections() {
175 return channelInitializer.size();
179 public ListenableFuture<Boolean> getIsOnlineFuture() {
180 return isOnlineFuture;
186 public int getPort() {
191 * @return the address
193 public String getAddress() {
198 * @param channelInitializer
200 public void setChannelInitializer(TcpChannelInitializer channelInitializer) {
201 this.channelInitializer = channelInitializer;
205 public void setThreadConfig(ThreadConfiguration threadConfig) {
206 this.threadConfig = threadConfig;
210 * Initiate event loop groups
211 * @param threadConfiguration number of threads to be created, if not specified in threadConfig
213 public void initiateEventLoopGroups(ThreadConfiguration threadConfiguration, boolean isEpollEnabled) {
216 initiateEpollEventLoopGroups(threadConfiguration);
218 initiateNioEventLoopGroups(threadConfiguration);
223 * Initiate Nio event loop groups
224 * @param threadConfiguration number of threads to be created, if not specified in threadConfig
226 public void initiateNioEventLoopGroups(ThreadConfiguration threadConfiguration) {
227 socketChannelClass = NioServerSocketChannel.class;
228 if (threadConfiguration != null) {
229 bossGroup = new NioEventLoopGroup(threadConfiguration.getBossThreadCount());
230 workerGroup = new NioEventLoopGroup(threadConfiguration.getWorkerThreadCount());
232 bossGroup = new NioEventLoopGroup();
233 workerGroup = new NioEventLoopGroup();
235 ((NioEventLoopGroup)workerGroup).setIoRatio(100);
239 * Initiate Epoll event loop groups with Nio as fall back
240 * @param threadConfiguration
242 protected void initiateEpollEventLoopGroups(ThreadConfiguration threadConfiguration) {
244 socketChannelClass = EpollServerSocketChannel.class;
245 if (threadConfiguration != null) {
246 bossGroup = new EpollEventLoopGroup(threadConfiguration.getBossThreadCount());
247 workerGroup = new EpollEventLoopGroup(threadConfiguration.getWorkerThreadCount());
249 bossGroup = new EpollEventLoopGroup();
250 workerGroup = new EpollEventLoopGroup();
252 ((EpollEventLoopGroup)workerGroup).setIoRatio(100);
254 } catch (Throwable ex) {
255 LOG.debug("Epoll initiation failed");
259 initiateNioEventLoopGroups(threadConfiguration);
263 * @return workerGroup
265 public EventLoopGroup getWorkerGroup() {