1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
.. _api-ref:
API Reference
=============
Serialization
-------------
.. toctree::
:maxdepth: 1
:hidden:
api/core_brine
* :ref:`api-brine` - A simple and fast serialization format for immutable data (numbers, string,
tuples, etc.). Brine is the "over-the-wire" encoding format of RPyC.
* :ref:`api-vinegar` - A configurable serializer for exceptions. Vinegar extracts the exception's
details and stores them in a brine-friendly format.
IO Layer
--------
.. toctree::
:maxdepth: 1
:hidden:
api/core_stream
* :ref:`api-stream` - The stream layer (byte-oriented, platform-agnostic streams)
* :ref:`api-channel` - The channel layer (framing and compression)
Protocol
--------
.. toctree::
:maxdepth: 1
:hidden:
api/core_netref
api/core_protocol
api/core_service
* :ref:`api-protocol` - The RPyC protocol (:class:`~rpyc.core.protocol.Connection` class)
* :ref:`api-service` - The RPyC service model
* :ref:`api-netref` - Implementation of transparent object proxies (netrefs)
* :ref:`api-async` - Asynchronous object proxies (netrefs)
Server-Side
-----------
.. toctree::
:maxdepth: 1
:hidden:
api/utils_server
api/utils_authenticators
api/utils_registry
* :ref:`api-server` - The core implementation of RPyC servers; includes the implementation of
the forking and threaded servers.
* :ref:`api-registry` - Implementation of the Service Registry; the registry is a bonjour-like
discovery agent, with which RPyC servers register themselves, and allows clients to locate
different servers by name.
* :ref:`api-authenticators` - Implementation of two common authenticators, for SSL and TLSlite.
Client-Side
-----------
.. toctree::
:maxdepth: 1
:hidden:
api/utils_factory
api/utils_classic
* :ref:`api-factory` - general-purpose connection factories (over pipes, sockets, SSL, SSH,
TLSlite, etc.)
* :ref:`api-classic` - *Classic-mode* factories and utilities
* :ref:`api-helpers` - Various helpers (``timed``, ``async_``, ``buffiter``, ``BgServingThread``,
etc.)
Misc
----
.. toctree::
:maxdepth: 1
:hidden:
api/utils_zerodeploy
* :ref:`api-zerodeploy` - Deploy short-living RPyC servers on remote machines with ease - all you'll
need is SSH access and a Python interpreter installed on the host
|
