Skip to content

Commit

Permalink
Merge pull request #180 from minrk/connect-reply
Browse files Browse the repository at this point in the history
Deprecate connect_request/reply
  • Loading branch information
Carreau authored Aug 5, 2016
2 parents 1e6b71c + e51a987 commit 40ed846
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/messaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -703,18 +703,27 @@ Message type: ``is_complete_reply``::
'indent': str,
}


Connect
-------

.. deprecated:: 5.1

connect_request/reply have not proved useful, and are considered deprecated.
Kernels are not expected to implement handlers for this message.

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

Message type: ``connect_request``::

content = {
}
content = {}

For example, a kernel with all channels running:

Message type: ``connect_reply``::

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


.. _msging_comm_info:

Comm info
Expand Down

0 comments on commit 40ed846

Please sign in to comment.