TripUpdateSource.java

/* This program is free software: you can redistribute it and/or
 modify it under the terms of the GNU Lesser 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 org.opentripplanner.updater.stoptime;

import java.util.List;

import com.google.transit.realtime.GtfsRealtime.TripUpdate;

public interface TripUpdateSource {
    /**
     * Wait for one message to arrive, and decode it into a List of TripUpdates. Blocking call.
     * @return a List<TripUpdate> potentially containing TripUpdates for several different trips,
     *         or null if an exception occurred while processing the message
     */
    public List<TripUpdate> getUpdates();
    
    /**
     * @return true iff the last list with updates represent all updates that are active right
     *        now, i.e. all previous updates should be disregarded
     */
    public boolean getFullDatasetValueOfLastUpdates();

    public String getFeedId();
}