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
|
.. _documentation:
Documentation
=============
Introduction
------------
.. toctree::
:maxdepth: 1
:hidden:
docs/about
docs/theory
docs/howto
docs/usecases
* :ref:`A little about RPyC <about>` - related projects, contributors, and
logo issues
* :ref:`Theory of Operation <theory>` - background on the inner workings of
RPyC and the terminology
* :ref:`Use cases <use-cases>` - some common use-cases, demonstrating the power
and ease of RPyC
* :ref:`How to's <howto>` - solutions to specific problems
Reference
---------
.. toctree::
:maxdepth: 1
:hidden:
docs/servers
docs/classic
docs/services
docs/async
docs/security
docs/secure-connection
docs/zerodeploy
docs/advanced-debugging
docs/rpyc-release-process
* :ref:`Servers <servers>` - using the built-in servers and writing custom ones
* :ref:`Classic RPyC <classic>` - using RPyC in *slave mode* (AKA *classic
mode*), where the client has unrestricted control over the server.
* :ref:`RPyC Services <services>` - writing well-defined services which restrict
the operations a client (or server) can carry out.
* :ref:`Asynchronous Operation <async>` - invoking operations in the background,
without having to wait for them to finish.
* :ref:`Security Concerns <security>` - keeping security in mind when using
RPyC
* :ref:`Secure Connections <ssl>` - create an encrypted and authenticated
connection over SSL or SSH
* :ref:`Zero-Deploy <zerodeploy>` - spawn temporary, short-lived RPyC server on remote
machine with nothing more than SSH and a Python interpreter
* :ref:`Advanced Debugging <advdebugging>` - debugging at the packet level
|