[QFJ-719] Document all FIX Session settings Created: 27/Nov/12  Updated: 30/Nov/12  Resolved: 30/Nov/12

Status: Resolved
Project: QuickFIX/J
Component/s: Documentation
Affects Version/s: 1.5.2
Fix Version/s: 1.5.3

Type: Bug Priority: Major
Reporter: Jörg Thönnes Assignee: Jörg Thönnes
Resolution: Fixed Votes: 0
Labels: None

Attachments: Zip Archive mylyn-context.zip     Zip Archive mylyn-context.zip     Zip Archive mylyn-context.zip     Zip Archive mylyn-context.zip    

 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".

 Comments   
Comment by Jörg Thönnes [ 30/Nov/12 ]

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
Comment by Jörg Thönnes [ 30/Nov/12 ]

Documented TestRequestDelayMultiplier.

Comment by Jörg Thönnes [ 30/Nov/12 ]

Finished documentation of all listed options and improved formatting.

Generated at Sat Nov 23 08:30:07 UTC 2024 using JIRA 7.5.2#75007-sha1:9f5725bb824792b3230a5d8716f0c13e296a3cae.