org.piax.gtrans.ov.ring.rq.RQReplyMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of piax-compat Show documentation

A backward compatibility package for PIAX

The newest version!

/*
 * RQReplyMessage.java - A class of reply message for range queries.
 * 
 * Copyright (c) 2015 Kota Abe / PIAX development team
 *
 * You can redistribute it and/or modify it under either the terms of
 * the AGPLv3 or PIAX binary code license. See the file COPYING
 * included in the PIAX package for more in detail.
 *
 * $Id: Link.java 1172 2015-05-18 14:31:59Z teranisi $
 */
package org.piax.gtrans.ov.ring.rq;

import java.util.Collection;
import java.util.List;

import org.piax.ayame.ov.rq.DKRangeRValue;
import org.piax.common.DdllKey;
import org.piax.common.PeerId;
import org.piax.gtrans.ov.ring.ReplyMessage;
import org.piax.gtrans.ov.ring.RingManager;

/**
 * a class representing a reply message against {@link RQMessage},
 * containing range query results.
 */
public class RQReplyMessage extends ReplyMessage {
    private static final long serialVersionUID = 1L;
    protected final PeerId senderId;
    protected final Collection> vals;
    /** is final reply? */
    protected final boolean isFinal;
    protected final Collection paths;
    protected final int hops;

    /**
     * constructor.
     * 
     * @param manager ring manager
     * @param req the RQMessage that this reply corresponds to.
     * @param vals return values
     * @param isFinal true if this reply message is the final message and no
     *            more reply message will be sent
     * @param paths message delivery paths
     * @param hops max hop count observed by this node (maybe)
     * @param unavailableKeys unavailable keys.
     */
    public RQReplyMessage(RingManager manager, RQMessage req,
            Collection> vals, boolean isFinal,
            Collection paths, int hops,
            List unavailableKeys) {
        super(manager, req, unavailableKeys);
        this.senderId = manager.getPeerId();
        this.vals = vals;
        this.isFinal = isFinal;
        this.paths = paths;
        this.hops = hops;
    }

    @Override
    public String toString() {
        return String
                .format("RQReplyMessage(senderId=%s, replyId=%s, vals=%s, isFinal=%s, paths=%s)",
                        senderId, replyId, vals, isFinal, paths);
    }
}