//-----------------------------------------------------------------------
// <copyright file="IMessaging.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace SharedObjects.Protocol
{
    using System;
    using global::SharedObjects.Misc;
    using global::SharedObjects.Protocol.OBD;

    /// <summary>
    /// Message handling methods.
    /// </summary>
    public interface IMessaging
    {
        /// <summary>
        /// Gets Current protocol handler instance.
        /// </summary>
        IProtocolHandler protocolHandler { get; }

        /// <summary>
        /// Trig sending of queued message.
        /// </summary>
        void sendMsg();

        /// <summary>
        /// Trig sending of queued message.
        /// </summary>
        /// <param name="restart">Message restart flag, used to ignore request while there are outstanding messages.</param>
        void sendMsg(bool restart);

        /// <summary>
        /// Queue message.
        /// </summary>
        /// <param name="msg">Message data.</param>
        /// <returns>'true' if successfully queued message, 'false' if there was an overrun and the message was discarded.</returns>
        bool queueMsg(IRequestData msg);

        /// <summary>
        /// Queue message.
        /// </summary>
        /// <param name="destinationAddress">Destination address for message, 'null' for Functional address.</param>
        /// <param name="msg">Message data.</param>
        void queueMsg(uint? destinationAddress, TxMsg msg);
    }
}