Skip to content

Commit

Permalink
Update README and .conf sample to reflect changes in syntax
Browse files Browse the repository at this point in the history
Signed-off-by: Joachim Wiberg <[email protected]>
  • Loading branch information
troglobit committed Feb 4, 2022
1 parent 277583e commit fb210d1
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 17 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,27 @@ version.

query-interval [1-1024] # default: 125 sec
query-response-interval [1-1024] # default: 10 sec
query-last-member-interval [1-1024] # default: 1
robustness [2-10] # default: 2
router-timeout [10-1024] # default: 255 sec

iface IFNAME [enable] [igmpv2 | igmpv3] # default: disable

Description:

* `multicast-query-interval`: the interval between IGMP/MLD queries,
when elected as querier for a LAN
* `multicast-robustness`: controls the tolerance to loss of replies
from end devices and the loss of elected queriers (above)
* `multicast-router-timeout`: also known as *"other querier present
interval"*, controls the timer used to detect when an elected
querier stops sending queries. When the timer expires `querierd`
will initiate a query. The default, when this is unset (commented
out) is calculated based on: `robustness * query-interval +
* `query-interval`: the interval between IGMP/MLD queries, when
elected as querier for a LAN
* `query-response-interval`: max response time to a query. Can be
used to control the burstiness of IGMP/MLD traffic
* `query-last-member-interval`: time between group specific queries,
the `robustness` setting controls the number of queries sent
* `robustness`: controls the tolerance to loss of replies from end
devices and the loss of elected queriers (above)
* `router-timeout`: also known as *"other querier present interval"*,
controls the timer used to detect when an elected querier stops
sending queries. When the timer expires `querierd` will initiate a
query. The default, when this is unset (commented out) is
calculated based on: `robustness * query-interval +
query-response-interval / 2`. Setting this to any value overrides
the RFC algorithm, which may be necessary in some scenarios, it is
however strongly recommended to leave this setting commented out!
Expand Down
33 changes: 25 additions & 8 deletions querierd.conf
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
# /etc/querierd.conf: sample configuration
# Global settings followed by per-interface enable/disable of features.
# By default, querierd is disabled on all interfaces.

# NOTE: it is strongly recommend leaving router-timeout commented-out!
# This is automatically calculated from the query interval and
# robustness according to RFC. The setting is just for override
# in particular use-cases.
# Query interval can be [1,1024], default 125. Recommended not go below 10
#query-interval 125

#query-interval 125
# The interval inside the query-interval that clients should respond
#query-response-interval 10
#robustness 2
#router-timeout 255

# Last member query interval [1,1024], default 1. The igmp-robustness
# setting controls the last member query count.
#query-last-member-interval 1

# Querier's robustness can be [2,10], default 2. Recommended to use 2
#robustness 2

# Controls the "other querier present interval", used to detect when an
# elected querier stops sending queries. Leave this commented-out, it
# is only available to override particular use-cases and interip with
# devices that do not follow the RFC. When commented out, the timeout
# is calculated from the query interval and robustness according to RFC.
#router-timeout 255

# IP Option Router Alert is enabled by default, for interop with stacks
# that hard-code the length of the IP header
#no router-alert

# Enable and one of the IGMP versions to use at startup, with fallback
# to older versions if older clients appear.
#iface vlan1 enable igmpv3
#iface vlan2 enable igmpv3
#iface vlan3 enable igmpv3

0 comments on commit fb210d1

Please sign in to comment.