Skip to content

docs: Document [peers_in_max] and [peers_out_max] in the example config - #7956

Open
pete-csyn wants to merge 1 commit into
XRPLF:developfrom
pete-csyn:docs/document-peers-in-out-max
Open

docs: Document [peers_in_max] and [peers_out_max] in the example config#7956
pete-csyn wants to merge 1 commit into
XRPLF:developfrom
pete-csyn:docs/document-peers-in-out-max

Conversation

@pete-csyn

Copy link
Copy Markdown

High Level Overview of Change

Documents [peers_in_max] and [peers_out_max] in cfg/xrpld-example.cfg. Comment
only — no behaviour change.

Context of Change

Both settings were added in #3616, which didn't touch a config file, so they have
never appeared in the example config. Today the only way to learn they exist — or
what they accept — is to read Config.cpp.

The behaviour most likely to cost someone time is that they must be set as a
pair. Configuring only one throws at startup:

Both sections [peers_in_max] and [peers_out_max] must be configured

which is easy to hit when trying to bound inbound connections alone. The valid
ranges also differ between the two (peers_in_max 0–1000, peers_out_max 10–1000),
and both are ignored when [peers_max] is present.

This documents the pair, the ranges, the both-or-neither requirement, and the
precedence, following the style of the surrounding stanzas. Verified against
src/xrpld/core/detail/Config.cpp on develop.

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

None — this changes only comments in the example config.

These two settings were added in XRPLF#3616 and have never appeared in the example
config, so the only way to learn they exist -- or what they accept -- is to read
Config.cpp.

The undocumented behaviour most likely to cost an operator time is that they must
be configured as a pair. Setting only one throws at startup ("Both sections
[peers_in_max] and [peers_out_max] must be configured"), which is a natural thing
to trip over when trying to bound inbound connections alone. The valid ranges
differ between the two, and both are silently ignored when [peers_max] is present.

Documents the pair, the ranges, the both-or-neither requirement, and the
[peers_max] precedence, following the existing style of the surrounding stanzas.
Comment only -- no behaviour change.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant