/*
* Created on Jan 8, 2005
* Created by Alon Rohter
* Copyright (C) 2004-2005 Aelitis, All Rights Reserved.
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* AELITIS, SAS au capital de 46,603.30 euros
* 8 Allee Lenotre, La Grille Royale, 78600 Le Mesnil le Roi, France.
*
*/
package com.aelitis.azureus.core.peermanager.messaging;
import org.gudy.azureus2.core3.util.DirectByteBuffer;
/**
* Basic peer message.
* A message is uniquely identified by the combination of ID and version.
*/
public interface Message {
/**
* Is a protocol-bearing message, i.e. messaging/overhead data.
*/
public static final int TYPE_PROTOCOL_PAYLOAD = 0;
/**
* Is a data-bearing message, i.e. file data.
*/
public static final int TYPE_DATA_PAYLOAD = 1;
/**
* Get message id.
* @return id
*/
public String getID();
public byte[] getIDBytes();
/**
* Get the main feature set name this message belongs to.
* @return feature id
*/
public String getFeatureID();
/**
* Get the static message sub-id for the feature.
* @return sub id
*/
public int getFeatureSubID();
public byte getVersion();
/**
* Get message type.
* @return type
*/
public int getType();
/**
* Get textual description of this particular message.
* @return description
*/
public String getDescription();
/**
* Get message payload data.
* @return message data buffers
*/
public DirectByteBuffer[] getData();
/**
* Create a new instance of this message by decoding the given byte serialization.
* @param data to deserialize
* @return decoded message instance
* @throws MessageException if the decoding process fails
* NOTE: Does not auto-return given direct buffer on thrown exception.
*/
public Message deserialize( DirectByteBuffer data, byte version ) throws MessageException;
/**
* Destroy the message; i.e. perform cleanup actions.
*/
public void destroy();
}