//-----------------------------------------------------------------------
// <copyright file="IRequestMatcher.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 Protocol.OBD
{
    using System;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Interface to request matching engine where responses
    /// are matched to an earlier request in order to improve
    /// parsing.
    /// </summary>
    public interface IRequestMatcher
    {
        /// <summary>
        /// Gets the number of requests that we wait for answer on.
        /// </summary>
        int openRequests { get; }

        /// <summary>
        /// Set request data to help with parsing the received data in some cases.
        /// </summary>
        /// <param name="requestData">Request data to set.</param>
        /// <returns>'true' on success.</returns>
        bool addRequestData(SharedObjects.Misc.IRequestData requestData);

        /// <summary>
        /// Find a matching request for the data we got.
        /// </summary>
        /// <param name="destinationAddress">Destination address to send to.</param>
        /// <param name="mode">Current mode.</param>
        /// <param name="payload">Payload data.</param>
        /// <returns>Matched request data.</returns>
        IRequestData getMatchingRequest(uint? destinationAddress, byte mode, byte[] payload);

        /// <summary>
        /// Check if address already is listed.
        /// <para>
        /// This method will also set 'false' if the time waiting for answer exceeds 2 seconds.
        /// </para>
        /// </summary>
        /// <param name="address">Address to check.</param>
        /// <returns>'true' if waiting for answer from ECU.</returns>
        bool hasListedAddress(uint address);
    }
}