/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library 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 */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using AgentService.Agent;

namespace AgentService.Platform.Modules
{
	/// <summary>
	/// Delegate MobilityEventHandler. Call-back signature for
	/// methods used to handle messages sent to core agents.
	/// </summary>
	public delegate void MobilityEventHandler(AgentPersistent persistedAgent, int ticket);

	/// <summary>
	/// Interface IMobilityModule. Defines the 
	/// basic functionalities that a mobility module
	/// must implement in order to be plugged
	/// into the AgentService platform
	/// </summary>
	public interface IMobilityModule
	{
		/// <summary>
		/// Move an agent from the local platform to the given platform
		/// </summary>
		/// <param name="profile">Profile of the agent to move</param>
		/// <param name="agentPersisted">Persisted version of the agent to move</param>
		/// <param name="destinationPlatform">Name of the destination platform</param>
		/// <returns>True if the transfer is successfull, false otherwise</returns>
		bool MoveAgent (AgentService.Agent.AgentProfile profile, AgentService.Agent.AgentPersistent agentPersisted, string destinationPlatform);

		/// <summary>
		/// Raises every time an agent is successfully received. Use null
		/// for the persistedAgent parameter if the transfer isn't succesfull
		/// </summary>
		event MobilityEventHandler agentTransferred;
	}
}