MessageID.java

/*
 * Mojito Distributed Hash Table (Mojito DHT)
 * Copyright (C) 2006-2007 LimeWire LLC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.limewire.mojito.messages;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import java.net.SocketAddress;

/**
 * A MessageID is an unique identifier for Messages. 
 */
public interface MessageID extends Serializable {

    /**
     * Returns true if tagging is supported.
     */
    public boolean isTaggingSupported();
    
    /**
     * Returns whether or not we're the originator of the MessageID.
     * 
     * @throws UnsupportedOperationException if tagging is not supported
     */
    public boolean isFor(SocketAddress dst);
    
    /**
     * Writes this MessageID to the OutputStream.
     */
    public void write(OutputStream os) throws IOException;

    /**
     * Returns the length of the MessageID in bytes.
     */
    public int getLength();
    
    /**
     * Returns the raw bytes of the MessageID. The
     * returned byte[] array is a copy and modifications
     * are not reflected to the MessageID.
     */
    public byte[] getBytes();

    /**
     * Returns the raw bytes of the current MessageID from the specified interval.
     */
    public byte[] getBytes(int srcPos, byte[] dest, int destPos, int length);
}