//-----------------------------------------------------------------------
// <copyright file="ISessionLayer.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;

    /// <summary>
    /// Session layer interface.
    /// </summary>
    public interface ISessionLayer : IDisposable
    {
        /// <summary>
        /// Receive one data packet.
        /// </summary>
        /// <param name="id">Address value.</param>
        /// <param name="data0">Payload data.</param>
        /// <param name="flags">Flags value.</param>
        /// <param name="res1">RES1 Value.</param>
        /// <param name="res2">RES2 Value.</param>
        void receiveData(uint id, byte[] data0, ushort flags, ulong res1, ulong res2);

        /// <summary>
        /// Set CAN bus communicator instance.
        /// </summary>
        /// <param name="iObdCommunicator">CAN bus communicator instance.</param>
        void setObdCommunicator(IObdCommunicator iObdCommunicator);
    }
}