@@ -134,14 +134,30 @@ class Proxy:
134134 """
135135 Start a 0MQ proxy on the local host.
136136
137+ The addresses can be specified flexibly. It is best to use
138+ a domain_socket (available on unix):
139+
140+ - ``'icp:///tmp/domain_socket'``
141+ - ``('ipc', '/tmp/domain_socket')``
142+
143+ tcp sockets are also supported:
144+
145+ - ``'tcp://localhost:6557'``
146+ - ``6657`` (implicitly binds to ``'tcp://localhost:6657'``
147+ - ``('tcp', 'localhost', 6657)``
148+ - ``('localhost', 6657)``
137149 Parameters
138150 ----------
139- in_port : int, optional
140- Port that RunEngines should broadcast to. If None, a random port is
141- used.
142- out_port : int, optional
143- Port that subscribers should subscribe to. If None, a random port is
144- used.
151+ in_address : str or tuple or int, optional
152+ Address that RunEngines should broadcast to.
153+
154+ If None, a random tcp port on all interfaces is used.
155+
156+ out_address : str or tuple or int, optional
157+ Address that subscribers should subscribe to.
158+
159+ If None, a random tcp port on all interfaces is used.
160+
145161 zmq : object, optional
146162 By default, the 'zmq' module is imported and used. Anything else
147163 mocking its interface is accepted.
0 commit comments