CollectData.java

/**
Copyright (c) 2007-2013 Alysson Bessani, Eduardo Alchieri, Paulo Sousa, and the authors indicated in the @author tags

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 bftsmart.tom.leaderchange;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.HashSet;

import bftsmart.consensus.TimestampValuePair;

/**
 * This class represents a COLLECT object with the information about the running consensus
 *
 * @author Joao Sousa
 */
public class CollectData implements Externalizable {

    private int pid; // process id
    private int cid; // consensus id
    private int ets; // consensus ETS
    private TimestampValuePair quorumWrites; // last value recevied from a Byzantine quorum of WRITEs
    private HashSet<TimestampValuePair> writeSet; // values written by the replica
    
    /**
     * Empty constructor
     */
    public CollectData() {
        pid = -1;
        cid = -1;
        ets = -1;
        quorumWrites = null;
        writeSet = null;
    }

    /**
     * Constructor
     *
     * @param pid process id
     * @param cid Consensus id
     * @param ets Consensus ETS
     * @param quorumWrites last value received from a Byzantine quorum of WRITEs
     * @param writeSet values written by the replica
     */
    public CollectData(int pid, int cid, int ets, TimestampValuePair quorumWrites, HashSet<TimestampValuePair> writeSet) {
        
        this.pid = pid;
        this.cid = cid;
        this.ets = ets;
        this.quorumWrites = quorumWrites;
        this.writeSet = writeSet;
    }

    /**
     * Get consensus id
     * @return consensus id
     */
    public int getCid() {
        return cid;
    }

    /**
     * Get consensus ETS
     * @return consensus ETS
     */
    public int getEts() {
        return ets;
    }
    
    /**
     * Get process id
     * @return process id
     */
    public int getPid() {
        return pid;
    }

    /**
     * Get value received from a Byzantine quorum of WRITEs
     * @return value received from a Byzantine quorum of WRITEs
     */
    public TimestampValuePair getQuorumWrites() {
        return quorumWrites;
    }

    /**
     * Get set of values written by the replica
     * @return set of values written by the replica
     */
    public HashSet<TimestampValuePair> getWriteSet() {
        return writeSet;
    }

    public boolean equals(Object obj) {

        if (obj instanceof CollectData) {

            CollectData c = (CollectData) obj;

            if (c.pid == pid) return true;
        }

        return false;
    }

    public int hashCode() {
        return pid;
    }

    public void writeExternal(ObjectOutput out) throws IOException{

        out.writeInt(pid);
        out.writeInt(cid);
        out.writeInt(ets);
        out.writeObject(quorumWrites);
        out.writeObject(writeSet);
    }

    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException{

        pid = in.readInt();
        cid = in.readInt();
        ets = in.readInt();
        quorumWrites = (TimestampValuePair) in.readObject();
        writeSet = (HashSet<TimestampValuePair>) in.readObject();
    }
}