Skip to content

Commit ceda312

Browse files
committed
add missing control_port to dict
and add text clarifying that it should be all running channels, and allowing for non-running channels to be omitted.
1 parent 1e6b71c commit ceda312

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/messaging.rst

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

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

709710
When a client connects to the request/reply socket of the kernel, it can issue
710711
a connect request to get basic information about the kernel, such as the ports
711712
the other ZeroMQ sockets are listening on. This allows clients to only have
712713
to know about a single port (the shell channel) to connect to a kernel.
714+
The ports for any additional channels the kernel is listening on should be included in the reply.
715+
If any ports are omitted from the reply, this indicates that the channels are not running.
713716

714717
Message type: ``connect_request``::
715718

716-
content = {
717-
}
719+
content = {}
720+
721+
For example, a kernel with all channels running:
718722

719723
Message type: ``connect_reply``::
720724

@@ -723,8 +727,10 @@ Message type: ``connect_reply``::
723727
'iopub_port' : int, # The port the PUB socket is listening on.
724728
'stdin_port' : int, # The port the stdin ROUTER socket is listening on.
725729
'hb_port' : int, # The port the heartbeat socket is listening on.
730+
'control_port' : int, # The port the control ROUTER socket is listening on.
726731
}
727732

733+
728734
.. _msging_comm_info:
729735

730736
Comm info

0 commit comments

Comments
 (0)