Uploaded image for project: 'QuickFIX/J'
  1. QuickFIX/J
  2. QFJ-719

Document all FIX Session settings

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.5.2
    • Fix Version/s: 1.5.3
    • Component/s: Documentation
    • Labels:
      None

      Description

      Answering a question posted on the mailing list I found at least one undocumented setting:

      • The TestRequestDelayMultiplier is not documented.

      So we should document it and at the same time check for other undocumented features.
      Here is the list of all session setttings (defined as constant with the prefix "SETTING_" in the Session class) which are
      not mentioned in the "configuration.html":

      • TestRequestDelayMultiplier
      • NonStopSession
      • DisableHeartBeatCheck
      • ForceResendWhenCorruptedStore
      • AllowedRemoteAddresses

      Steps

      • Added documentation for missing items.
      • Corrected formatting:
      • Some settings are not in italics.
      • Always "Y<BR>N".

        Attachments

          Activity

          Hide
          jthoennes Jörg Thönnes added a comment -

          Extracted the text strings of all SETTINGS_* constants from the Session class and did a grep on the configuration.html:

          for s in $(< QFJ-Settings-List.txt ); do echo -n "$s:"; grep -c "$s" configuration.html ; done|grep :0
          TestRequestDelayMultiplier:0
          NonStopSession:0
          DisableHeartBeatCheck:0
          ForceResendWhenCorruptedStore:0
          AllowedRemoteAddresses:0
          
          Show
          jthoennes Jörg Thönnes added a comment - Extracted the text strings of all SETTINGS_* constants from the Session class and did a grep on the configuration.html: for s in $(< QFJ-Settings-List.txt ); do echo -n "$s:" ; grep -c "$s" configuration.html ; done|grep :0 TestRequestDelayMultiplier:0 NonStopSession:0 DisableHeartBeatCheck:0 ForceResendWhenCorruptedStore:0 AllowedRemoteAddresses:0
          Hide
          jthoennes Jörg Thönnes added a comment -

          Documented TestRequestDelayMultiplier.

          Show
          jthoennes Jörg Thönnes added a comment - Documented TestRequestDelayMultiplier.
          Hide
          jthoennes Jörg Thönnes added a comment -

          Finished documentation of all listed options and improved formatting.

          Show
          jthoennes Jörg Thönnes added a comment - Finished documentation of all listed options and improved formatting.

            People

            • Assignee:
              jthoennes Jörg Thönnes
              Reporter:
              jthoennes Jörg Thönnes
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: