[[user-comments:osrf-devel:user_s_guide|User Comments]]

===== OpenSRF -- The Book =====

  - [[Introduction and Setup]]
    - [[Benefits of OpenSRF over other Application Frameworks]]
      - [[Language Agnostic]]
      - standard message formats -- XML, JSON
      - persistent TCP network connections -- crosses firewalls
    - [[Notes on compiling C/C++ code]]
    - [[installing software]]
    - [[Configuring Jabber]]
      - [[Chop Chop, Jabber]]
        - [[Compiling Chop Chop]]
        - [[Running Chop Chop]]
      - [[jabberd]]
        - [[no-store and escape patches]]
        - [[basic configuration]]
   - single host installation
      - jabber
      - configuring the server bootstrap config
      - configuring the client bootstrap config
        - network client
        - local client
        - srfsh
    - multi-host network installation
      - Jabber
      - configuring the server bootstrap config
      - configuring the client bootstrap config
        - network client
        - local client
        - srfsh
    - multi-host multi-domain network installation
      - jabber
      - configuring the server bootstrap config
      - configuring the client bootstrap config
        - network client
        - local client
        - srfsh
    - configuring the global application config file
    - starting everthing up and testing
      - starting the stock servers (settings, persist, math and mathdb)
      - connecting with srfsh
      - running a test app (math_bench.pl)
  - client development guide
    - AppSession types
      - session oriented virtual connections -- multi-call state
      - single request stateless connections
    - calling conventions and uses
      - Perl API
        - super-simple "method lookup" style calls
        - simple stateless calls using create->request->gather
        - simple serialized stateful calls using create->connect->(request->wait_complete->gather)->disconnect
        - simple concurrent stateful requests using create->connect->request...->gather
      - user managed sessions and requests using create->connect->request->complete/recv->failed/content->disconnect
    - [[osrf-devel:python|Configuring Python clients]]
    -  the Settings server
      - the SettingsClient
    - [[Persist Server API|Persist Application API]]
      - [[persist-slot|General Persistence Slot methods]]
      - [[persist-object|OBJECT Persistence methods]]
      - [[persist-stacks|STACK Persistence methods]]
      - [[persist-queue|QUEUE Persistence methods]]
  - administration, testing and scripts with srfsh
  - server development guide
    - [[perl-server-dev|Perl Application Development API]]
      - [[example-server|Example Application Server]]

  * Appendix A) annotated config files
    * [[Client -- bootstrap.conf]]
    * [[Server -- bootstrap.conf]]
    * [[srfsh -- ~/.srfsh.xml]]
  * Appendix B) advanced srfsh
  * Appendix C) interpreting the log files
  * [[terms|Appendix D)]] Definition of [[terms]] in OpenSRF