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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
Application
------------
.. autoclass:: proton.vpn.core.Application
:members:
:special-members: __init__
:undoc-members:
Orchestrators
--------------
Orchestrators delegate the operations on Controllers, which themselves delegate operations to the
components (VPNConnection component, VPNAccount component, VPNServers components, etc)
.. code-block:: ascii
+------+
| View |
+---+--+
|
+--v--+
| App |
+--+--+
|
|
+---------------+ +-------v--------+
| Session | | Connection |
| Orchestrator <--+ Orchestrator +---------+------------------+
+------+--------+ +--------+-------+ | |
| | | |
| | | |
| | +-------v------+ +-----v--------+
| | | VPN Servers | | User Settings|
+-------------+ | | Orchestrator | | Orchestrator |
| | | +-------+------+ +--------------+
| | | |
+-------v---+ | | |
|Proton VPN | +------v------+ +---------v-----+ +-------v------+
|Session | | Credentials | |VPN Connection | | VPN Servers |
|Controller | | Controller | | Controller | | Controller |
+-----------+ +-------------+ +---------------+ +--------------+
See :
- :class:`proton.vpn.core.controllers.vpnsession.VPNSessionController`
- :class:`proton.vpn.core.controllers.vpnconnection.VPNConnectionController`
- :class:`proton.vpn.core.controllers.vpncredentials.VPNCredentialController`
- :class:`proton.vpn.core.controllers.vpnservers.VPNServersController`
For controllers documentation.
Orchestrators
--------------
.. autoclass:: proton.vpn.core.orchestrators.usersettings.UserSettingsOrchestrator
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.orchestrators.vpnconnection.VPNConnectionOrchestrator
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.orchestrators.vpnserver.VPNServerOrchestrator
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.orchestrators.vpnsession.VPNSessionOrchestrator
:members:
:special-members: __init__
:undoc-members:
Controllers
--------------
Controllers implement the high level business logic of the application, ensuring that the VPN
service is in a consistent state.
.. autoclass:: proton.vpn.core.controllers.vpnconnection.VPNConnectionController
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.controllers.vpncredentials.VPNCredentialController
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.controllers.vpnservers.VPNServersController
:members:
:special-members: __init__
:undoc-members:
.. autoclass:: proton.vpn.core.controllers.vpnsession.VPNSessionController
:members:
:special-members: __init__
:undoc-members:
User Settings
-------------
.. autoclass:: proton.vpn.core.controllers.usersettings.BasicSettings
:members:
:special-members: __init__
:undoc-members:
Persistence
------------
.. autoclass:: proton.vpn.core.controllers.usersettings.FilePersistence
:members:
:special-members: __init__
:undoc-members:
Views
------
An abstract view of the user interface.
.. autoclass:: proton.vpn.core.views.BaseView
:members:
:special-members: __init__
:undoc-members:
|
