org.apache.thrift.transport.TNonblockingServerSocket Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of libthrift Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.thrift.transport;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.SocketException;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.SocketChannel;
import org.apache.thrift.TConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Wrapper around ServerSocketChannel */
public class TNonblockingServerSocket extends TNonblockingServerTransport {
  private static final Logger LOGGER =
      LoggerFactory.getLogger(TNonblockingServerSocket.class.getName());

  /** This channel is where all the nonblocking magic happens. */
  private ServerSocketChannel serverSocketChannel = null;

  /** Underlying ServerSocket object */
  private ServerSocket serverSocket_ = null;

  /** Timeout for client sockets from accept */
  private int clientTimeout_ = 0;

  /** Limit for client sockets request size */
  private int maxFrameSize_ = 0;

  public static class NonblockingAbstractServerSocketArgs
      extends AbstractServerTransportArgs {}

  /** Creates just a port listening server socket */
  public TNonblockingServerSocket(int port) throws TTransportException {
    this(port, 0);
  }

  /** Creates just a port listening server socket */
  public TNonblockingServerSocket(int port, int clientTimeout) throws TTransportException {
    this(port, clientTimeout, TConfiguration.DEFAULT_MAX_FRAME_SIZE);
  }

  public TNonblockingServerSocket(int port, int clientTimeout, int maxFrameSize)
      throws TTransportException {
    this(
        new NonblockingAbstractServerSocketArgs()
            .port(port)
            .clientTimeout(clientTimeout)
            .maxFrameSize(maxFrameSize));
  }

  public TNonblockingServerSocket(InetSocketAddress bindAddr) throws TTransportException {
    this(bindAddr, 0);
  }

  public TNonblockingServerSocket(InetSocketAddress bindAddr, int clientTimeout)
      throws TTransportException {
    this(bindAddr, clientTimeout, TConfiguration.DEFAULT_MAX_FRAME_SIZE);
  }

  public TNonblockingServerSocket(InetSocketAddress bindAddr, int clientTimeout, int maxFrameSize)
      throws TTransportException {
    this(
        new NonblockingAbstractServerSocketArgs()
            .bindAddr(bindAddr)
            .clientTimeout(clientTimeout)
            .maxFrameSize(maxFrameSize));
  }

  public TNonblockingServerSocket(NonblockingAbstractServerSocketArgs args)
      throws TTransportException {
    clientTimeout_ = args.clientTimeout;
    maxFrameSize_ = args.maxFrameSize;
    try {
      serverSocketChannel = ServerSocketChannel.open();
      serverSocketChannel.configureBlocking(false);

      // Make server socket
      serverSocket_ = serverSocketChannel.socket();
      // Prevent 2MSL delay problem on server restarts
      serverSocket_.setReuseAddress(true);
      // Bind to listening port
      serverSocket_.bind(args.bindAddr, args.backlog);
    } catch (IOException ioe) {
      serverSocket_ = null;
      throw new TTransportException(
          "Could not create ServerSocket on address " + args.bindAddr.toString() + ".", ioe);
    }
  }

  public void listen() throws TTransportException {
    // Make sure not to block on accept
    if (serverSocket_ != null) {
      try {
        serverSocket_.setSoTimeout(0);
      } catch (SocketException sx) {
        LOGGER.error("Socket exception while setting socket timeout", sx);
      }
    }
  }

  @Override
  public TNonblockingSocket accept() throws TTransportException {
    if (serverSocket_ == null) {
      throw new TTransportException(TTransportException.NOT_OPEN, "No underlying server socket.");
    }
    try {
      SocketChannel socketChannel = serverSocketChannel.accept();
      if (socketChannel == null) {
        return null;
      }

      TNonblockingSocket tsocket = new TNonblockingSocket(socketChannel);
      tsocket.setTimeout(clientTimeout_);
      tsocket.setMaxFrameSize(maxFrameSize_);
      return tsocket;
    } catch (IOException iox) {
      throw new TTransportException(iox);
    }
  }

  public void registerSelector(Selector selector) {
    try {
      // Register the server socket channel, indicating an interest in
      // accepting new connections
      serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);
    } catch (ClosedChannelException e) {
      // this shouldn't happen, ideally...
      // TODO: decide what to do with this.
    }
  }

  public void close() {
    if (serverSocket_ != null) {
      try {
        serverSocket_.close();
      } catch (IOException iox) {
        LOGGER.warn("WARNING: Could not close server socket: " + iox.getMessage());
      }
      serverSocket_ = null;
    }
  }

  public void interrupt() {
    // The thread-safeness of this is dubious, but Java documentation suggests
    // that it is safe to do this from a different thread context
    close();
  }

  public int getPort() {
    if (serverSocket_ == null) return -1;
    return serverSocket_.getLocalPort();
  }

  // Expose it for test purpose.
  ServerSocketChannel getServerSocketChannel() {
    return serverSocketChannel;
  }
}