/*********************************************************************/
/*                                                                   */
/*                     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;
using AgentService.Agent.Knowledge;
using AgentService.Agent.Behaviour;
using AgentService.Platform.AMS;

namespace AgentService.Platform.MTS
{
    /// <summary>
    /// Class MTSProxy. Acts as an instance proxy for a 
    /// cross domain interaction with the MTS.
    /// </summary>
    public class MTSProxy : MarshalByRefObject, IMTSGateway
    {

        /// <summary>
        /// reference to the mts.
        /// </summary>
        private IMTSGateway mts;
        /// <summary>
        /// Constructs an MTS Agent for the given platform.
        /// </summary>
        /// <param name="platform">Reference to the MTS</param>
        public MTSProxy(IMTSGateway obj)
        {
            this.mts = obj;
        }

        /// <summary>
        /// Checks whether a queue has messages.
        /// </summary>
        /// <param name="aid">agent identifier of the owner of the queue</param>
        /// <returns>true if the queue has messages</returns>
        public bool HasMessages(AID aid)
        {
            return this.mts.HasMessages(aid);
        }

        /// <summary>
        /// Sends a message to an agent.
        /// </summary>
        /// <param name="message">message</param>
        /// <returns>true if the message has been successfully sent</returns>
        public bool SendMessage(AgentMessage message)
        {
            return this.mts.SendMessage(message);
        }

        /*
        /// <summary>
        /// Receives a message pops it from the queue.
        /// </summary>
        /// <param name="aid">agent identifier of the agent that owns the queue</param>
        /// <returns>the first message available in the queue</returns>
        public AgentMessage ReceiveMessage(AID aid)
        {
            return this.mts.ReceiveMessage(aid);
        }

        /// <summary>
        /// Looks in the queue for a message.
        /// </summary>
        /// <param name="aid">agent identifier of the agent that owns the queue</param>
        /// <returns>the first message available in the queue</returns>
        public AgentMessage PeekMessage(AID aid)
        {
            return this.mts.PeekMessage(aid);
        }
        */

        /// <summary>
        /// Retrieves all the messages and removes them from the queue.
        /// </summary>
        /// <param name="aid">agent identifier of the agent that owns the queue</param>
        /// <param name="filter">message filter, set this parameter to null if you do not want to applay any filter</param>
        /// <param name="max">max number or message to retrieve</param>
        /// <param name="bRemove">if true removes the message from the queue</param>
        /// <returns>the collection of messages retrieved from the queue</returns>
        public AgentMessageCollection GetMessages(AID aid, MessageFilter filter, int max, bool bRemove)
        {
            return this.mts.GetMessages(aid, filter, max, bRemove);
        }

        /// <summary>
        /// Retrieves the first message satisfying the given conditions from the agent's queue.
        /// </summary>
        /// <param name="aid">agent identifier of the agent that owns the queue</param>
        /// <param name="filter">message filter, set this parameter to null if you do not want to apply a filter</param>
        /// <param name="bRemove">if true removes the messages from the queue</param>
        /// <returns>the collection of messages retrieved from the queue</returns>
        public AgentMessage GetMessage(AID aid, MessageFilter filter, bool bRemove)
        {

            AgentMessage message = null;

            message = this.mts.GetMessage(aid, filter, bRemove);
            return message;

        }
        /// <summary>
        /// Removes the given message from the queue.
        /// </summary>
        /// <param name="aid">agent identifier of the agent that owns the queue</param>
        /// <param name="message">message to be destroyed</param>
        /// <returns>true if message is successfully removed</returns>
        public bool RemoveMessage(AID aid, AgentMessage message)
        {
            return this.mts.RemoveMessage(aid, message);
        }
    }
}