net.kuujo.vertigo.instance.impl.ControlledInputConnection.java Source code

Java tutorial

Introduction

Here is the source code for net.kuujo.vertigo.instance.impl.ControlledInputConnection.java

Source

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed 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 net.kuujo.vertigo.instance.impl;

import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.eventbus.DeliveryOptions;
import io.vertx.core.eventbus.EventBus;
import io.vertx.core.eventbus.Message;
import io.vertx.core.eventbus.MessageConsumer;
import io.vertx.core.logging.Logger;
import io.vertx.core.logging.LoggerFactory;
import net.kuujo.vertigo.message.VertigoMessage;
import net.kuujo.vertigo.spi.VertigoMessageFactory;
import net.kuujo.vertigo.instance.InputConnection;
import net.kuujo.vertigo.context.InputConnectionContext;

/**
 * Input connection implementation.
 *
 * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
 */
public class ControlledInputConnection<T> implements InputConnection<T>, Handler<Message<T>> {
    protected static final String ACTION_HEADER = "action";
    protected static final String ID_HEADER = "name";
    protected static final String INDEX_HEADER = "index";
    protected static final String MESSAGE_ACTION = "message";
    protected static final String ACK_ACTION = "ack";
    protected static final String FAIL_ACTION = "fail";
    protected static final String PAUSE_ACTION = "pause";
    protected static final String RESUME_ACTION = "resume";
    private static final long BATCH_SIZE = 1000;
    private static final long MAX_BATCH_TIME = 100;
    private final Logger log;
    protected final Vertx vertx;
    protected final EventBus eventBus;
    protected final InputConnectionContext context;
    protected final String inAddress;
    protected final String outAddress;
    protected final VertigoMessageFactory messageFactory;
    private MessageConsumer<T> consumer;
    protected Handler<VertigoMessage<T>> messageHandler;
    private long lastReceived;
    private long lastFeedbackTime;
    private long feedbackTimerID;
    private boolean paused;

    private final Handler<Long> internalTimer = new Handler<Long>() {
        @Override
        public void handle(Long timerID) {
            // Ensure that feedback messages are sent at least every second or so.
            // This will ensure that feedback is still provided when output connections
            // are full, otherwise the feedback will never be triggered.
            long currentTime = System.currentTimeMillis();
            if (currentTime - lastFeedbackTime > 1000) {
                ack();
            }
        }
    };

    private final Handler<Message<T>> internalMessageHandler = new Handler<Message<T>>() {
        @Override
        public void handle(Message<T> message) {
            if (!paused) {
                String action = message.headers().get(ACTION_HEADER);
                switch (action) {
                case MESSAGE_ACTION:
                    if (checkIndex(Long.valueOf(message.headers().get(INDEX_HEADER)))) {
                        doMessage(message);
                    }
                    break;
                }
            }
        }
    };

    public ControlledInputConnection(Vertx vertx, InputConnectionContext context,
            VertigoMessageFactory messageFactory) {
        this.vertx = vertx;
        this.eventBus = vertx.eventBus();
        this.context = context;
        this.messageFactory = messageFactory;
        this.inAddress = String.format("%s.in", context.port().input().component().address());
        this.outAddress = String.format("%s.out", context.port().input().component().address());
        this.log = LoggerFactory.getLogger(String.format("%s-%s", ControlledInputConnection.class.getName(),
                context.port().input().component().address()));
        feedbackTimerID = vertx.setPeriodic(MAX_BATCH_TIME, internalTimer);
    }

    @Override
    public void handle(Message<T> message) {
        Long index = Long.valueOf(message.headers().get("index"));
        if (index != null && checkIndex(index)) {
            doMessage(message);
        }
    }

    /**
     * Checks that the given index is valid.
     */
    protected boolean checkIndex(long index) {
        // Ensure that the given ID is a monotonically increasing ID.
        // If the ID is less than the last received ID then reset the
        // last received ID since the connection must have been reset.
        if (lastReceived == 0 || index == lastReceived + 1 || index < lastReceived) {
            lastReceived = index;
            // If the ID reaches the end of the current batch then tell the data
            // source that it's okay to remove all previous messages.
            if (lastReceived % BATCH_SIZE == 0) {
                ack();
            }
            return true;
        } else {
            fail();
        }
        return false;
    }

    /**
     * Sends an ack message for the current received count.
     */
    protected void ack() {
        // Send a message to the other side of the connection indicating the
        // last message that we received in order. This will allow it to
        // purge messages we've already received from its queue.
        if (log.isDebugEnabled()) {
            log.debug("{} - Acking messages up to: {}", this, lastReceived);
        }
        eventBus.send(outAddress, null, new DeliveryOptions().addHeader(ACTION_HEADER, ACK_ACTION)
                .addHeader(INDEX_HEADER, String.valueOf(lastReceived)));
        lastFeedbackTime = System.currentTimeMillis();
    }

    /**
     * Sends a fail message for the current received count.
     */
    protected void fail() {
        // Send a "fail" message indicating the last message we received in order.
        // This will cause the other side of the connection to resend messages
        // in order from that point on.
        if (log.isDebugEnabled()) {
            log.debug("{} - Received a message out of order: {}", this, lastReceived);
        }
        eventBus.send(outAddress, null, new DeliveryOptions().addHeader(ACTION_HEADER, FAIL_ACTION)
                .addHeader(INDEX_HEADER, String.valueOf(lastReceived)));
        lastFeedbackTime = System.currentTimeMillis();
    }

    @Override
    public InputConnection<T> pause() {
        if (!paused) {
            paused = true;
            log.debug("{} - Pausing connection: {}", this, context.source());
            eventBus.send(outAddress, null, new DeliveryOptions().addHeader(ACTION_HEADER, PAUSE_ACTION)
                    .addHeader(INDEX_HEADER, String.valueOf(lastReceived)));
        }
        return this;
    }

    @Override
    public InputConnection<T> resume() {
        if (paused) {
            paused = false;
            log.debug("{} - Resuming connection: {}", this, context.source());
            eventBus.send(outAddress, null, new DeliveryOptions().addHeader(ACTION_HEADER, RESUME_ACTION)
                    .addHeader(INDEX_HEADER, String.valueOf(lastReceived)));
        }
        return this;
    }

    @Override
    public InputConnection<T> handler(Handler<VertigoMessage<T>> handler) {
        this.messageHandler = handler;
        return this;
    }

    /**
     * Handles receiving a message.
     */
    @SuppressWarnings("unchecked")
    protected void doMessage(final Message<T> message) {
        if (messageHandler != null) {
            String id = message.headers().get(ID_HEADER);
            VertigoMessage<T> vertigoMessage = messageFactory.<T>createVertigoMessage(id, message);

            if (log.isDebugEnabled()) {
                log.debug("{} - Received: Message[name={}, value={}]", this, id, message);
            }
            messageHandler.handle(vertigoMessage);
        }
    }

    @Override
    public String toString() {
        return context.toString();
    }

}