message.java

High performance DB query

/*
 * @(#)$Id: Message.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.bamboo.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 Message
 *
 */
public class Message extends BambooMessage {

    public static long serialVersionUID =
        SerializationManager.getSerialUID(
            "overlay.location.bamboo.payload.Message");
    private BitID destination;
    private long applicationID;
    private Payload message;
    private boolean provideUpCalls;
    private byte hopCount;
    private static FreeList freeList = new FreeList(new MessageFactory());

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

        this.destination = new BitID(inputBuffer);
        this.applicationID = inputBuffer.getLong();
        this.message = SerializationManager.deSerialize(inputBuffer);
        this.provideUpCalls = SerializeBool.deSerialize(inputBuffer);
        this.hopCount = inputBuffer.get();
    }

    /**
     * Serialize the object into the provided GenericByteBuffer.
     *
     * @param outputBuffer
     * @return
     */
    public long serialize(GenericByteBuffer outputBuffer) {
        super.serialize(outputBuffer);
        destination.serialize(outputBuffer);
        outputBuffer.putLong(applicationID);
        SerializationManager.serialize(outputBuffer, message);
        SerializeBool.serialize(outputBuffer, provideUpCalls);
        outputBuffer.put(hopCount);

        return serialVersionUID;
    }

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

    private void init(int messageID, InetSocketAddress sourceSocketAddress,
                      BitID destination, long applicationID, Payload message,
                      boolean provideUpCalls) {
        super.init(messageID, sourceSocketAddress);

        this.destination = destination;
        this.applicationID = applicationID;
        this.message = message;
        this.provideUpCalls = provideUpCalls;
        this.hopCount = 0;
    }

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

    /**
     * Method getDestination
     * @return
     */
    public BitID getDestination() {
        return destination;
    }

    /**
     * Method getApplicationID
     * @return
     */
    public long getApplicationID() {
        return applicationID;
    }

    /**
     * Method getMessage
     * @return
     */
    public Payload getMessage() {
        return message;
    }

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

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

    /**
     * Method updateHopCount
     *
     * @param increment
     */
    public void updateHopCount(byte increment) {
        hopCount += increment;
    }

    /**
     * Method allocate
     *
     * @param messageID
     * @param sourceSocketAddress
     * @param destination
     * @param applicationID
     * @param message
     * @param provideUpCalls
     * @return
     */
    public static Message allocate(int messageID,
                                   InetSocketAddress sourceSocketAddress,
                                   BitID destination, long applicationID,
                                   Payload message, boolean provideUpCalls) {
        Message theMessage = (Message) freeList.allocate();

        theMessage.init(messageID, sourceSocketAddress, destination,
                        applicationID, message, provideUpCalls);

        return theMessage;
    }

    /**
     * Method allocate
     *
     * @param oldMessage
     * @return
     */
    public static Message allocate(Message oldMessage) {
        Message message = (Message) freeList.allocate();

        message.init(oldMessage.messageID, oldMessage.sourceSocketAddress,
                     oldMessage.destination, oldMessage.applicationID,
                     oldMessage.message, oldMessage.provideUpCalls);

        return message;
    }

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


/**
 * Class MessageFactory
 *
 */
class MessageFactory implements FreeListFactory {

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