Skip to content

Commit d9e3677

Browse files
docs: add missing middleware configuration fields (#251)
1 parent 32c8428 commit d9e3677

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

docs/configuration/middleware-configuration.rst

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ running on 'localhost' listening on port 8500. These values can be changed via t
3939
TcpReceiveBufferSize: 1024
4040
RegistryAsFallbackProxy: false
4141
ConnectTimeoutSeconds: 5.0
42+
EnableDomainSockets: false
43+
AcceptorUris:
44+
- tcp://0.0.0.0:0
45+
- local:///tmp/my.own.socket
4246
4347
.. list-table:: Middleware Configuration
4448
:widths: 15 85
@@ -70,13 +74,6 @@ running on 'localhost' listening on port 8500. These values can be changed via t
7074
* - TcpReceiveBufferSize
7175
- Sets the TCP receive buffer size. Be careful when changing the OS defaults!
7276

73-
* - AcceptorUris
74-
- Overwrite the default acceptor URIs of the participant. The configuration
75-
field exists to support more complicated network setups, where the
76-
listening ports of the participant must have a known, fixed port number
77-
and address.
78-
|NormalOperationNotice|
79-
8077
* - RegistryAsFallbackProxy
8178
- Disable using the registry as a proxy for participant-to-participant
8279
communication as a fallback, if the direct connection attempts fail.
@@ -88,3 +85,29 @@ running on 'localhost' listening on port 8500. These values can be changed via t
8885
- The timeout (in seconds) until a connection attempt is aborted or a handshake is considered failed.
8986
This timeout applies to each attempt (TCP, Local-Domain) individually.
9087
|NormalOperationNotice|
88+
89+
* - EnableDomainSockets
90+
- By default, a participant connects to, and listens for connections on a local domain socket (in addition to TCP).
91+
Setting this flag to ``false`` disables connection attempts and listening for connections on domain sockets.
92+
This can be useful for testing and debugging.
93+
|NormalOperationNotice|
94+
95+
* - AcceptorUris
96+
- Overwrite the default acceptor URIs of the participant. The configuration
97+
field exists to support more complicated network setups, where the
98+
listening ports of the participant must have a known, fixed port number
99+
and address.
100+
This field expects a list of strings.
101+
102+
Each string identifies a socket endpoint used to listen for incoming connections, for TCP or local domain sockets.
103+
104+
* ``tcp://<ip>:<port>``, e.g.,
105+
106+
* ``tcp://10.123.15.33:36812`` to listen on ``10.123.15.33`` for incoming TCP connections on port ``36812``
107+
* ``tcp://[::]:33445`` to listen for connections on any IPv6 address of the host on port ``33445``
108+
109+
* ``local://<path>``, e.g.,
110+
111+
* ``local:///tmp/my.socket`` to listen on a local domain socket identified by the path ``/tmp/my.socket``
112+
113+
|NormalOperationNotice|

0 commit comments

Comments
 (0)