Skip to content

Commit 40ed846

Browse files
authored
Merge pull request #180 from minrk/connect-reply
Deprecate connect_request/reply
2 parents 1e6b71c + e51a987 commit 40ed846

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/messaging.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -703,18 +703,27 @@ Message type: ``is_complete_reply``::
703703
'indent': str,
704704
}
705705

706+
706707
Connect
707708
-------
708709

710+
.. deprecated:: 5.1
711+
712+
connect_request/reply have not proved useful, and are considered deprecated.
713+
Kernels are not expected to implement handlers for this message.
714+
709715
When a client connects to the request/reply socket of the kernel, it can issue
710716
a connect request to get basic information about the kernel, such as the ports
711717
the other ZeroMQ sockets are listening on. This allows clients to only have
712718
to know about a single port (the shell channel) to connect to a kernel.
719+
The ports for any additional channels the kernel is listening on should be included in the reply.
720+
If any ports are omitted from the reply, this indicates that the channels are not running.
713721

714722
Message type: ``connect_request``::
715723

716-
content = {
717-
}
724+
content = {}
725+
726+
For example, a kernel with all channels running:
718727

719728
Message type: ``connect_reply``::
720729

@@ -723,8 +732,10 @@ Message type: ``connect_reply``::
723732
'iopub_port' : int, # The port the PUB socket is listening on.
724733
'stdin_port' : int, # The port the stdin ROUTER socket is listening on.
725734
'hb_port' : int, # The port the heartbeat socket is listening on.
735+
'control_port' : int, # The port the control ROUTER socket is listening on.
726736
}
727737

738+
728739
.. _msging_comm_info:
729740

730741
Comm info

0 commit comments

Comments
 (0)