org.glassfish.grizzly.thrift.TGrizzlyClientTransport Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly.thrift;

import org.apache.thrift.transport.TTransportException;
import org.glassfish.grizzly.Buffer;
import org.glassfish.grizzly.Connection;
import org.glassfish.grizzly.GrizzlyFuture;
import org.glassfish.grizzly.memory.MemoryManager;
import org.glassfish.grizzly.utils.BufferOutputStream;

import java.io.IOException;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeUnit;

import org.glassfish.grizzly.Processor;
import org.glassfish.grizzly.filterchain.FilterChain;

/**
 * TGrizzlyClientTransport is the client-side TTransport.
 * 
 * BlockingQueue which belongs to ThriftClientFilter has input messages when server's response are arrived.
 * Only TTransport#flush() will be called, output messages will be written. Before flush(), output messages will be stored in buffer.
 *
 * @author Bongjae Chang
 */
public class TGrizzlyClientTransport extends AbstractTGrizzlyTransport {

    private static final int DEFAULT_READ_TIMEOUT_Millis = -1; // never timed out

    public static TGrizzlyClientTransport create(final Connection connection) {
        return create(connection, DEFAULT_READ_TIMEOUT_Millis);
    }

    public static TGrizzlyClientTransport create(final Connection connection, final int readTimeoutMillis) {
        if (connection == null) {
            throw new IllegalStateException("Connection should not be null");
        }
        
        final Processor processor = connection.getProcessor();
        
        if (!(processor instanceof FilterChain)) {
            throw new IllegalStateException("Connection's processor has to be a FilterChain");
        }

        final FilterChain connectionFilterChain = (FilterChain) connection.getProcessor();
        final int idx = connectionFilterChain.indexOfType(ThriftClientFilter.class);
        
        if (idx == -1) {
            throw new IllegalStateException("Connection has to have ThriftClientFilter in the FilterChain");
        }
        
        final ThriftClientFilter thriftClientFilter =
                (ThriftClientFilter) connectionFilterChain.get(idx);

        if (thriftClientFilter == null) {
            throw new IllegalStateException("thriftClientFilter should not be null");
        }

        final BlockingQueue inputBuffersQueue = thriftClientFilter.getInputBuffersQueue();

        if (inputBuffersQueue == null) {
            throw new IllegalStateException("inputBuffersQueue should not be null");
        }

        return new TGrizzlyClientTransport(connection, inputBuffersQueue, readTimeoutMillis);
    }

    private Buffer input = null;
    private final Connection connection;
    private final BlockingQueue inputBuffersQueue;
    private final BufferOutputStream outputStream;
    private final int readTimeoutMillis;

    private TGrizzlyClientTransport(final Connection connection,
            final BlockingQueue inputBuffersQueue,
            final int readTimeoutMillis) {
        this.connection = connection;
        
        this.inputBuffersQueue = inputBuffersQueue;
        this.outputStream = new BufferOutputStream(
                connection.getTransport().getMemoryManager()) {

            @Override
            protected Buffer allocateNewBuffer(
                    final MemoryManager memoryManager, final int size) {
                final Buffer b = memoryManager.allocate(size);
                b.allowBufferDispose(true);
                return b;
            }
        };
        this.readTimeoutMillis = readTimeoutMillis;
    }

    @Override
    public boolean isOpen() {
        return connection.isOpen();
    }

    @Override
    public void close() {
        final Buffer output = outputStream.getBuffer();
        output.dispose();
        try {
            outputStream.close();
        } catch (IOException ignore) {
        }
        try {
            final GrizzlyFuture closeFuture = connection.close();
            closeFuture.get(10, TimeUnit.SECONDS);
        } catch (Exception ignore) {
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void flush() throws TTransportException {
        checkConnectionOpen();
        
        final Buffer output = outputStream.getBuffer();
        output.trim();
        outputStream.reset();

        connection.write(output);
    }

    @Override
    protected Buffer getInputBuffer() throws TTransportException {
        Buffer localInput = this.input;
        if (localInput == null) {
            localInput = getLocalInput(readTimeoutMillis);
        } else if (localInput.remaining() <= 0) {
            localInput.dispose();
            localInput = getLocalInput(readTimeoutMillis);
        }
        if (localInput == null) {
            throw new TTransportException( "timed out while reading the input buffer");
        }
        this.input = localInput;
        return localInput;
    }

    private Buffer getLocalInput(final int readTimeoutMillis) throws TTransportException {
        final Buffer localInput;
        try {
            if (readTimeoutMillis < 0) {
                localInput = inputBuffersQueue.take();
            } else {
                localInput = inputBuffersQueue.poll(readTimeoutMillis, TimeUnit.MILLISECONDS);
            }
        } catch (InterruptedException ie) {
            Thread.currentThread().interrupt();
            throw new TTransportException(ie);
        }
        return localInput;
    }

    @Override
    protected BufferOutputStream getOutputStream() {
        return outputStream;
    }

    private void checkConnectionOpen() throws TTransportException {
        if (!isOpen()) {
            throw new TTransportException("Client connection is closed");
        }
    }
}