//-----------------------------------------------------------------------
// <copyright file="ICanCommunicator.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.CAN
{
    using System;

    /// <summary>
    /// Declaration of methods needed for CAN communication interface.
    /// <para>
    /// At the moment only supporting Vector (http://www.vector.com/) XL-driver library.
    /// </para>
    /// </summary>
    public interface ICanCommunicator : IDisposable
    {
        /// <summary>
        /// Gets or sets time in milliseconds between sent frames.
        /// </summary>
        long frameSpacing { get; set; }

        /// <summary>
        /// Unregister as a data receiver instance
        /// </summary>
        /// <param name="iDataReceiver">Data receiver instance.</param>
        void removeDataReceiver(IDataReceiver iDataReceiver);

        /// <summary>
        /// Register as a data receiver instance
        /// </summary>
        /// <param name="iDataReceiver">Data receiver instance.</param>
        void addDataReceiver(IDataReceiver iDataReceiver);

        /// <summary>
        /// Send data.
        /// </summary>
        /// <param name="id">Target address.</param>
        /// <param name="bytes">Data to send.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "bytes", Justification = "Reviewed, intentional")]
        void send(uint id, byte[] bytes);

        /// <summary>
        /// Start CAN communication.
        /// </summary>
        void startCan();

        /// <summary>
        /// Stop CAN communication.
        /// </summary>
        void stopCan();
    }
}