org.apache.thrift.transport.TServerTransport.java Source code

Introduction

Here is the source code for org.apache.thrift.transport.TServerTransport.java

Source

/*
 * 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.Closeable;
import java.net.InetSocketAddress;

/**
 * Server transport. Object which provides client transports.
 *
 */
public abstract class TServerTransport implements Closeable {

    public static abstract class AbstractServerTransportArgs<T extends AbstractServerTransportArgs<T>> {
        int backlog = 0; // A value of 0 means the default value will be used (currently set at 50)
        int clientTimeout = 0;
        InetSocketAddress bindAddr;

        public T backlog(int backlog) {
            this.backlog = backlog;
            return (T) this;
        }

        public T clientTimeout(int clientTimeout) {
            this.clientTimeout = clientTimeout;
            return (T) this;
        }

        public T port(int port) {
            this.bindAddr = new InetSocketAddress(port);
            return (T) this;
        }

        public T bindAddr(InetSocketAddress bindAddr) {
            this.bindAddr = bindAddr;
            return (T) this;
        }
    }

    public abstract void listen() throws TTransportException;

    /**
     * Accept incoming connection on the server socket. When there is no incoming connection available:
     * either it should block infinitely in a blocking implementation, either it should return null in
     * a nonblocking implementation.
     *
     * @return new connection
     * @throws TTransportException if IO error.
     */
    public abstract TTransport accept() throws TTransportException;

    public abstract void close();

    /**
     * Optional method implementation. This signals to the server transport
     * that it should break out of any accept() or listen() that it is currently
     * blocked on. This method, if implemented, MUST be thread safe, as it may
     * be called from a different thread context than the other TServerTransport
     * methods.
     */
    public void interrupt() {
    }

}