README 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. -------------------------------------------------------------------------------
  2. DojoX Stores (data)
  3. -------------------------------------------------------------------------------
  4. Version 1.000
  5. Release date: 03/04/2011
  6. -------------------------------------------------------------------------------
  7. Project state:
  8. LightstreamerStore: beta
  9. -------------------------------------------------------------------------------
  10. [ ] l18n support?
  11. [ ] a11y support?
  12. -------------------------------------------------------------------------------
  13. Credits
  14. LightstreamerStore: Kris Zyp (kris@sitepen.com)
  15. Tom Trenka (ttrenka@gmail.com)
  16. Lightstreamer (http://lightstreamer.com)
  17. -------------------------------------------------------------------------------
  18. Project description
  19. DojoX Stores is intended to serve as a place where experimental stores based
  20. on the dojo.store APIs can live. At the time of writing, only the
  21. LightstreamerStore is available, but more stores may be added in the future.
  22. The LightstreamerStore is a lightweight object store that is intended to be
  23. used with the Lightstreamer Web Client and the Lightstreamer Server. It allows
  24. one to connect to a Lightstreamer server and get continuous updates (depending
  25. on the data adapter and mode used). Because it requires the Lightstreamer
  26. server, unit tests are not functional here; there is a demonstration of it in
  27. action (URL to be determined).
  28. -------------------------------------------------------------------------------
  29. Dependencies:
  30. The main dependency of the LightstreamerStore is dojo/store/util/QueryResults.
  31. -------------------------------------------------------------------------------
  32. Documentation
  33. LightstreamerStore: inline API documentation is included.
  34. -------------------------------------------------------------------------------
  35. Installation instructions
  36. Download the Dojo distribution and set up your Lightstreamer instance, and go!
  37. -------------------------------------------------------------------------------
  38. Additional Notes
  39. LightstreamerStore: The main place to hook your code to is to define an "observe"
  40. function on the results from a query; this function will be passed a JSON-like
  41. object, with which you can do anything you want.