org.opentripplanner.updater.stoptime

Class WebsocketGtfsRealtimeUpdater

java.lang.Object

org.opentripplanner.updater.stoptime.WebsocketGtfsRealtimeUpdater

All Implemented Interfaces:

GraphUpdater, JsonConfigurable

public class WebsocketGtfsRealtimeUpdater
extends Object
implements GraphUpdater

This class starts an HTTP client which opens a websocket connection to a GTFS-RT data source. A callback is registered which handles incoming GTFS-RT messages as they stream in by placing a GTFS-RT decoder Runnable task in the single-threaded executor for handling. Usage example ('websocket' name is an example) in the file 'Graph.properties':

 websocket.type = websocket-gtfs-rt-updater
 websocket.defaultAgencyId = agency
 websocket.url = ws://localhost:8088/tripUpdates
 

Constructor Summary

Constructors

Constructor and Description
WebsocketGtfsRealtimeUpdater()

Method Summary

Modifier and Type	Method and Description
void	configure(Graph graph, com.fasterxml.jackson.databind.JsonNode config)
void	run() This method will run in its own thread.
void	setGraphUpdaterManager(GraphUpdaterManager updaterManager) Graph updaters must be aware of their manager to be able to execute GraphWriterRunnables.
void	setup(Graph graph) Here the updater can be initialized.
void	teardown() Here the updater can clean up after itself.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebsocketGtfsRealtimeUpdater

public WebsocketGtfsRealtimeUpdater()

Method Detail

setGraphUpdaterManager

public void setGraphUpdaterManager(GraphUpdaterManager updaterManager)

Description copied from interface: GraphUpdater

Graph updaters must be aware of their manager to be able to execute GraphWriterRunnables. GraphUpdaterConfigurator should take care of calling this function.

Specified by:

setGraphUpdaterManager in interface GraphUpdater

configure

public void configure(Graph graph,
                      com.fasterxml.jackson.databind.JsonNode config)
               throws Exception

Specified by:

configure in interface JsonConfigurable

Throws:

Exception

setup

public void setup(Graph graph)
           throws InterruptedException,
                  ExecutionException

Description copied from interface: GraphUpdater

Here the updater can be initialized. If it throws, the updater won't be started (i.e. the run method won't be called). All updaters' setup methods will be run sequentially in a single-threaded manner before updates begin, in order to avoid concurrent reads/writes.

Specified by:

setup in interface GraphUpdater

Throws:

InterruptedException

ExecutionException

run

public void run()
         throws InterruptedException

Description copied from interface: GraphUpdater

This method will run in its own thread. It pulls or receives updates and applies them to the graph. It must perform any writes to the graph by passing GraphWriterRunnables to GraphUpdaterManager.execute(). This queues up the write operations, ensuring that only one updater performs writes at a time.

Specified by:

run in interface GraphUpdater

Throws:

InterruptedException

teardown

public void teardown()

Description copied from interface: GraphUpdater

Here the updater can clean up after itself.

Specified by:

teardown in interface GraphUpdater