route.java

High performance DB query

/*
 * @(#)$Id: Route.java,v 1.8 2004/07/02 23:59:20 huebsch Exp $
 *
 * Copyright (c) 2001-2004 Regents of the University of California.
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached BERKELEY-LICENSE
 * file. If you do not find these files, copies can be found by writing to:
 * Computer Science Division, Database Group, Universite of California,
 * 617 Soda Hall #1776, Berkeley, CA 94720-1776. Attention: Berkeley License
 *
 * Copyright (c) 2003-2004 Intel Corporation. All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE file.
 * If you do not find these files, copies can be found by writing to:
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300,
 * Berkeley, CA, 94704.  Attention:  Intel License Inquiry.
 */


package overlay.location.chord.payload;

import java.net.InetSocketAddress;
import services.network.Payload;
import util.BitID;
import util.FreeList;
import util.FreeListFactory;
import util.network.serialization.GenericByteBuffer;
import util.network.serialization.SerializationManager;
import util.network.serialization.SerializeBool;

/**
 * Class Route
 *
 */
public class Route extends ChordMessage {

    public static long serialVersionUID =
        SerializationManager.getSerialUID(
            "overlay.location.chord.payload.Route");
    private BitID destinationID;
    private ChordMessage theMessage;
    private boolean recursive, toSuccessor, provideUpCalls;
    private int hopCount;
    private static FreeList freeList = new FreeList(new RouteFactory());

    /**
     * DeSerialize the object from the provided GenericByteBuffer.
     *
     * @param inputBuffer
     */
    public Route(GenericByteBuffer inputBuffer) {
        super(inputBuffer);

        this.destinationID = new BitID(inputBuffer);
        this.theMessage =
            (ChordMessage) SerializationManager.deSerialize(inputBuffer);

        boolean bools[] = SerializeBool.deSerialize(inputBuffer, 3);

        this.recursive = bools[0];
        this.toSuccessor = bools[1];
        this.provideUpCalls = bools[2];
        this.hopCount = inputBuffer.getInt();
    }

    /**
     * Serialize the object into the provided GenericByteBuffer.
     *
     * @param outputBuffer
     * @return
     */
    public long serialize(GenericByteBuffer outputBuffer) {
        super.serialize(outputBuffer);
        destinationID.serialize(outputBuffer);
        SerializationManager.serialize(outputBuffer, theMessage);
        SerializeBool.serialize(outputBuffer, recursive, toSuccessor,
                                provideUpCalls);
        outputBuffer.putInt(hopCount);

        return serialVersionUID;
    }

    /**
     * Constructor Route
     */
    protected Route() {}

    private void init(int messageID, InetSocketAddress sourceSocketAddress,
                      BitID destinationID, ChordMessage theMessage,
                      boolean recursive, boolean toSuccessor,
                      boolean provideUpCalls) {
        super.init(messageID, sourceSocketAddress);

        this.destinationID = destinationID;
        this.theMessage = theMessage;
        this.recursive = recursive;
        this.toSuccessor = toSuccessor;
        this.provideUpCalls = provideUpCalls;
        hopCount = 0;
    }

    /**
     * Method getSize
     * @return
     */
    public int getSize() {
        return super.getSize() + Payload.INET_SOCKET_SIZE
               + SerializationManager.getPayloadSize(theMessage) + 1
               + Payload.INT_SIZE;
    }

    /**
     * Method getDestinationID
     * @return
     */
    public BitID getDestinationID() {
        return destinationID;
    }

    /**
     * Method getTheMessage
     * @return
     */
    public ChordMessage getTheMessage() {
        return theMessage;
    }

    /**
     * Method getRecursive
     * @return
     */
    public boolean getRecursive() {
        return recursive;
    }

    /**
     * Method getToSuccessor
     * @return
     */
    public boolean getToSuccessor() {
        return toSuccessor;
    }

    /**
     * Method getProvideUpCalls
     * @return
     */
    public boolean getProvideUpCalls() {
        return provideUpCalls;
    }

    /**
     * Method getHopCount
     * @return
     */
    public int getHopCount() {
        return hopCount;
    }

    /**
     * Method incrementHops
     *
     * @param delta
     */
    public void incrementHops(int delta) {
        hopCount += delta;
    }

    /**
     * Method allocate
     *
     * @param messageID
     * @param sourceSocketAddress
     * @param destinationID
     * @param theMessage
     * @param recursive
     * @param toSuccessor
     * @param provideUpCalls
     * @return
     */
    public static Route allocate(int messageID,
                                 InetSocketAddress sourceSocketAddress,
                                 BitID destinationID, ChordMessage theMessage,
                                 boolean recursive, boolean toSuccessor,
                                 boolean provideUpCalls) {
        Route message = (Route) freeList.allocate();

        message.init(messageID, sourceSocketAddress, destinationID, theMessage,
                     recursive, toSuccessor, provideUpCalls);

        return message;
    }

    /**
     * Method free
     *
     * @param message
     */
    public static void free(Route message) {
        freeList.free(message);
    }
}


/**
 * Class RouteFactory
 *
 */
class RouteFactory implements FreeListFactory {

    /**
     * Method create
     * @return
     */
    public Object create() {
        return new Route();
    }
}