/*********************************************************************/
/*                                                                   */
/*                     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 System.Collections.Generic;
using System.Text;
using AgentService.Interface;

namespace AgentService.Platform.MTS
{
    /// <summary>
    /// Interface IMTSGateway. Defines the common operation that are
    /// directly accessible from the messaging clients on each agent.
    /// </summary>
    public interface IMTSGateway
    {
        /// <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>
        bool HasMessages(IAID aid);

        /// <summary>
        /// Sends a message to an agent.
        /// </summary>
        /// <param name="message">message</param>
        /// <returns>true if the message has been successfully sent</returns>
        bool SendMessage(IAgentMessage 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>
        IAgentMessage ReceiveMessage(IAID 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>
        IAgentMessage PeekMessage(IAID 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>
        /// <returns>the collection of messages retrieved from the queue</returns>
        IAgentMessageCollection GetAllMessages(IAID aid);

        /// <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>
        bool RemoveMessage(IAID aid, IAgentMessage message);
    }
}