Good Practice

From Open Rail Data Wiki
Revision as of 21:01, 11 July 2015 by Q (talk | contribs) (Added category)
Jump to navigation Jump to search

Please bear in mind the following points when you use the service - they're here to make sure everyone gets a good service:

  • Sign up with one account - it gives an accurate reflection of how many people are actually using the service
  • Connect to the service once - you can subscribe to multiple topics or queues in a single connection. Don't use separate connections for each of the feeds
  • Don't leave a failed client running - if you can connect but get an authentication or authorization error - stop your client - don't leave it continually trying
  • Make sure your client handles failures - if your client fails to connect or is disconnected, use an exponential backoff and wait 1s, 2s, 4s, 8s, 16s etc. before trying to reconnect. Service problems sometimes occur, and if everyone tries to reconnect every second, the service will not recover quickly
  • Use a durable subscriber for topics - if you want data to be queued in case you disconnect, request a durable subscription for the Network Rail platform when you connect
  • Use Stomp heartbeats to detect network problems that may otherwise leave your client hanging with no data