/*
 *
 *  * ******************************************************************************
 *  * Copyright (C) 2014-2019 Dennis Sheirer
 *  *
 *  * 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/>
 *  * *****************************************************************************
 *
 *
 */
package io.github.dsheirer.message;

import io.github.dsheirer.identifier.Identifier;
import io.github.dsheirer.protocol.Protocol;

import java.util.List;

public interface IMessage
{
    /**
     * Timestamp for when the message was transmitted or processed
     * @return milliseconds since epoch timestamp
     */
    long getTimestamp();

    /**
     * Indicates if the message is valid and has passed all error detection and correction.
     */
    boolean isValid();

    /**
     * Protocol name associated with the message
     */
    Protocol getProtocol();

    /**
     * Indicates the timeslot for the message
     * @return timeslot (0-based)
     */
    int getTimeslot();

    /**
     * List of identifiers present in the message
     * @return list of identifiers or an empty list
     */
    List<Identifier> getIdentifiers();
}