org.elasticsearch.http.netty4.pipelining.HttpPipeliningHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transport-netty4 Show documentation
Elasticsearch subproject :modules:transport-netty4
There is a newer version: 6.2.3.31
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.elasticsearch.http.netty4.pipelining;

import io.netty.channel.ChannelDuplexHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelPromise;
import io.netty.handler.codec.http.LastHttpContent;
import org.apache.logging.log4j.Logger;
import org.elasticsearch.transport.netty4.Netty4Utils;

import java.nio.channels.ClosedChannelException;
import java.util.Collections;
import java.util.PriorityQueue;

/**
 * Implements HTTP pipelining ordering, ensuring that responses are completely served in the same order as their corresponding requests.
 */
public class HttpPipeliningHandler extends ChannelDuplexHandler {

    // we use a priority queue so that responses are ordered by their sequence number
    private final PriorityQueue holdingQueue;

    private final Logger logger;
    private final int maxEventsHeld;

    /*
     * The current read and write sequence numbers. Read sequence numbers are attached to requests in the order they are read from the
     * channel, and then transferred to responses. A response is not written to the channel context until its sequence number matches the
     * current write sequence, implying that all preceding messages have been written.
     */
    private int readSequence;
    private int writeSequence;

    /**
     * Construct a new pipelining handler; this handler should be used downstream of HTTP decoding/aggregation.
     *
     * @param logger for logging unexpected errors
     * @param maxEventsHeld the maximum number of channel events that will be retained prior to aborting the channel connection; this is
     *                      required as events cannot queue up indefinitely
     */
    public HttpPipeliningHandler(Logger logger, final int maxEventsHeld) {
        this.logger = logger;
        this.maxEventsHeld = maxEventsHeld;
        this.holdingQueue = new PriorityQueue<>(1);
    }

    @Override
    public void channelRead(final ChannelHandlerContext ctx, final Object msg) throws Exception {
        if (msg instanceof LastHttpContent) {
            ctx.fireChannelRead(new HttpPipelinedRequest(((LastHttpContent) msg).retain(), readSequence++));
        } else {
            ctx.fireChannelRead(msg);
        }
    }

    @Override
    public void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) throws Exception {
        if (msg instanceof HttpPipelinedResponse) {
            final HttpPipelinedResponse current = (HttpPipelinedResponse) msg;
            /*
             * We attach the promise to the response. When we invoke a write on the channel with the response, we must ensure that we invoke
             * the write methods that accept the same promise that we have attached to the response otherwise as the response proceeds
             * through the handler pipeline a different promise will be used until reaching this handler. Therefore, we assert here that the
             * attached promise is identical to the provided promise as a safety mechanism that we are respecting this.
             */
            assert current.promise() == promise;

            boolean channelShouldClose = false;

            synchronized (holdingQueue) {
                if (holdingQueue.size() < maxEventsHeld) {
                    holdingQueue.add(current);

                    while (!holdingQueue.isEmpty()) {
                        /*
                         * Since the response with the lowest sequence number is the top of the priority queue, we know if its sequence
                         * number does not match the current write sequence number then we have not processed all preceding responses yet.
                         */
                        final HttpPipelinedResponse top = holdingQueue.peek();
                        if (top.sequence() != writeSequence) {
                            break;
                        }
                        holdingQueue.remove();
                        /*
                         * We must use the promise attached to the response; this is necessary since are going to hold a response until all
                         * responses that precede it in the pipeline are written first. Note that the promise from the method invocation is
                         * not ignored, it will already be attached to an existing response and consumed when that response is drained.
                         */
                        ctx.write(top.response(), top.promise());
                        writeSequence++;
                    }
                } else {
                    channelShouldClose = true;
                }
            }

            if (channelShouldClose) {
                try {
                    Netty4Utils.closeChannels(Collections.singletonList(ctx.channel()));
                } finally {
                    current.release();
                    promise.setSuccess();
                }
            }
        } else {
            ctx.write(msg, promise);
        }
    }

    @Override
    public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception {
        if (holdingQueue.isEmpty() == false) {
            ClosedChannelException closedChannelException = new ClosedChannelException();
            HttpPipelinedResponse pipelinedResponse;
            while ((pipelinedResponse = holdingQueue.poll()) != null) {
                try {
                    pipelinedResponse.release();
                    pipelinedResponse.promise().setFailure(closedChannelException);
                } catch (Exception e) {
                    logger.error("unexpected error while releasing pipelined http responses", e);
                }
            }
        }
        ctx.close(promise);
    }
}