neighbor.java

High performance DB query

/*
 * @(#)$Id: Neighbor.java,v 1.7 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.can;

import java.net.InetSocketAddress;
import services.network.Payload;
import util.network.serialization.GenericByteBuffer;
import util.network.serialization.SerializationManager;
import util.network.serialization.SerializeInetSocketAddress;

/**
 * The class encapsulates a CAN neighbor, fit for transport.  The neighbor
 * object contains the address of the neighbor and its zone.
 */
public class Neighbor implements Payload {

    public static long serialVersionUID =
        SerializationManager.getSerialUID("overlay.location.can.Neighbor");
    private InetSocketAddress address;
    private Zone zone;
    private int version;

    /**
     * DeSerialize the object from the provided GenericByteBuffer.
     *
     * @param inputBuffer
     */
    public Neighbor(GenericByteBuffer inputBuffer) {
        this.address = SerializeInetSocketAddress.deSerialize(inputBuffer, 4);
        this.zone = new Zone(inputBuffer);
        this.version = inputBuffer.getInt();
    }

    /**
     * Serialize the object into the provided GenericByteBuffer.
     *
     * @param outputBuffer
     * @return
     */
    public long serialize(GenericByteBuffer outputBuffer) {
        SerializeInetSocketAddress.serialize(outputBuffer, address);
        zone.serialize(outputBuffer);
        outputBuffer.putInt(version);

        return serialVersionUID;
    }

    /**
     * Constructor Neighbor
     *
     * @param address
     * @param zone
     * @param version
     */
    public Neighbor(InetSocketAddress address, Zone zone, int version) {
        this.address = address;
        this.zone = zone;
        this.version = version;
    }

    /**
     * Constructor Neighbor
     *
     * @param oldNeighbor
     */
    public Neighbor(Neighbor oldNeighbor) {
        this.address = oldNeighbor.address;
        this.zone = oldNeighbor.zone;
        this.version = oldNeighbor.version;
    }

    /**
     * Method getAddress
     * @return
     */
    public InetSocketAddress getAddress() {
        return address;
    }

    /**
     * Method getZone
     * @return
     */
    public Zone getZone() {
        return zone;
    }

    /**
     * Method getVersion
     * @return
     */
    public int getVersion() {
        return version;
    }

    /**
     * Method getSize
     * @return
     */
    public int getSize() {
        return Payload.INET_SOCKET_SIZE + zone.getSize();
    }

    /**
     * Method toString
     * @return
     */
    public String toString() {
        return "<NEIGHBOR: AD: " + address + ", ZN: " + zone + " VE: "
               + version + ">";
    }
}