Skip to content

Commit

Permalink
Updated BgServingThread documentation to link to #522 to explain what…
Browse files Browse the repository at this point in the history
… is expected default behavior as a caveat.
  • Loading branch information
comrumino committed Mar 10, 2023
1 parent ec5fbe5 commit ba07bae
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion rpyc/utils/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,11 @@ class BgServingThread(object):
"""Runs an RPyC server in the background to serve all requests and replies
that arrive on the given RPyC connection. The thread is started upon the
the instantiation of the ``BgServingThread`` object; you can use the
:meth:`stop` method to stop the server thread
:meth:`stop` method to stop the server thread.
CAVEAT: RPyC defaults to bind_threads as False. So, there is no guarantee that the
background thread will serve the request. See issue #522 for an example of this behavior.
As the bind_threads feature matures, we may change the default to to True in the future.
Example::
Expand Down

0 comments on commit ba07bae

Please sign in to comment.