Skip to content

Commit

Permalink
Closes #511, expanded docstring for Connection to explain the life-cy…
Browse files Browse the repository at this point in the history
…cle of local/remote objects
  • Loading branch information
comrumino committed Oct 31, 2022
1 parent b1c35df commit 40b6eb3
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions rpyc/core/protocol.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,11 @@ class PingError(Exception):
class Connection(object):
"""The RPyC *connection* (AKA *protocol*).
Objects referenced over the connection are either local or remote. This class retains a strong reference to
local objects that is deleted when the reference count is zero. Remote/proxied objects have a life-cycle
controlled by a different address space. Since garbage collection is handled on the remote end, a weak reference
is used for netrefs.
:param root: the :class:`~rpyc.core.service.Service` object to expose
:param channel: the :class:`~rpyc.core.channel.Channel` over which messages are passed
:param config: the connection's configuration dict (overriding parameters
Expand Down

0 comments on commit 40b6eb3

Please sign in to comment.