//-----------------------------------------------------------------------
// <copyright file="IMessageHandler.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 global::SharedObjects.Api;
    using global::SharedObjects.Protocol;

    /// <summary>
    /// Interface to layer that acts as an intermediate between the API and the protocol handler.
    /// </summary>
    public interface IMessageHandler
    {
        /// <summary>
        /// Glue method for error handler.
        /// </summary>
        /// <param name="res">Result code.</param>
        /// <param name="errtext">Error text.</param>
        /// <returns>'true' if execution can continue.</returns>
        bool errTestConnection(PassThruConstants.resultCode res, out string errtext);

        /// <summary>
        /// Get the payload part of the message with the header stripped off.
        /// </summary>
        /// <param name="msg">Message to get payload from.</param>
        /// <returns>Byte array with payload data.</returns>
        byte[] getPayload(IPassThruMsg msg);

        /// <summary>
        /// Perform a fast initialization. (Only KWP2000)
        /// </summary>
        /// <param name="protocolId">Protocol ID</param>
        /// <param name="srcaddress">Source address to use.</param>
        /// <param name="result">Result message from init.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlFastInit(int protocolId, uint srcaddress, out IPassThruMsg result);

        /// <summary>
        /// Perform a five baud initialization. (Only for ISO9141, KWP2000)
        /// </summary>
        /// <param name="target">Target address.</param>
        /// <param name="outBytes">Number of received bytes.</param>
        /// <param name="keyword1">Keyword 1.</param>
        /// <param name="keyword2">Keyword 2.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlFiveBaudInit(uint target, out uint outBytes, out uint keyword1, out uint keyword2);

        /// <summary>
        /// Gets locking object to handle concurrency when writing to raw log file.
        /// </summary>
        object messageLockObject { get; }

        /// <summary>
        /// Send the given message.
        /// </summary>
        /// <param name="txmsg">Message to send.</param>
        /// <returns>Status code from operation, 0=Success.</returns>
        PassThruConstants.resultCode sendMessage(IPassThruMsg txmsg);

        /// <summary>
        /// Configure the protocol handler for this message handler.
        /// </summary>
        /// <param name="protocolHandler">Protocol handler instance.</param>
        void setProtocolCallback(IMsgCallback protocolHandler);

        /// <summary>
        /// Set the receiver of raw messages for this protocol handler.
        /// Notice that the value may be 'null'.
        /// </summary>
        /// <param name="rawReceiver">Instance of raw data receiver.</param>
        void setRawReceiver(IRawReceiver rawReceiver);

        /// <summary>
        /// Change the timeout value.
        /// </summary>
        /// <param name="timeout">New timeout value.</param>
        void setTimeout(int timeout);

        /// <summary>
        /// Starts a periodically sent message, e.g. for keep alive of a connection.
        /// </summary>
        /// <param name="msg">Message to send.</param>
        /// <param name="msgId">Message ID.</param>
        /// <returns>Status of action.</returns>
        PassThruConstants.resultCode startPeriodicMessage(IPassThruMsg msg, out int msgId);

        /// <summary>
        /// Start Message Listener thread.
        /// </summary>
        void startThread();

        /// <summary>
        /// Stops a periodically sent message.
        /// </summary>
        /// <param name="msgId">ID of message to stop as provided by startPeriodicMessage()</param>
        void stopPeriodicMessage(int msgId);

        /// <summary>
        /// Stop the Message Listener thread.
        /// </summary>
        void stopThread();
    }
}