Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(547)

Side by Side Diff: doc/manager-api.txt

Issue 6659006: flimflam: add support for multiple profiles (Closed) Base URL: ssh://git@gitrw.chromium.org:9222/flimflam.git@master
Patch Set: more ers comments Created 9 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « configure.ac ('k') | doc/profile-api.txt » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Manager hierarchy 1 Manager hierarchy
2 ================= 2 =================
3 3
4 Service org.chromium.flimflam 4 Service org.chromium.flimflam
5 Interface org.chromium.flimflam.Manager 5 Interface org.chromium.flimflam.Manager
6 Object path / 6 Object path /
7 7
8 Methods dict GetProperties() 8 Methods dict GetProperties()
9 9
10 Returns all global system properties. See the 10 Returns all global system properties. See the
(...skipping 14 matching lines...) Expand all
25 string GetState() 25 string GetState()
26 26
27 Return global connection state of a system. The 27 Return global connection state of a system. The
28 same value is return via the State property. 28 same value is return via the State property.
29 29
30 Possible Errors: [service].Error.InvalidArguments 30 Possible Errors: [service].Error.InvalidArguments
31 31
32 object CreateProfile(string name) 32 object CreateProfile(string name)
33 33
34 Create and add new profile with the specified 34 Create and add new profile with the specified
35 » » » identifier name. 35 » » » identifier name. The name should either be in the
36 » » » form ``name'' or ``~user/name'' where where ``user''
37 » » » is the login name of a user suitable for finding
38 » » » their home directory. Both strings must contain
39 » » » only alpha-numeric ASCII characters.
40
41 » » » Profiles created without a user name are stored in
42 » » » a system directory readable only by the connection
43 » » » mananger. Profiles created with a user name are
44 » » » stored in the user's home directory but readable
45 » » » only by the connection manager.
46
47 » » » If any existing profile is specified its contents
48 » » » are reset to a default (minimal) contents. If the
49 » » » profile is already registered with a CreateProfile
50 » » » or PushProfile request then an error is returned.
51
52 » » » Possible Errors: [service].Error.InvalidArguments
53 » » » » » [service].Error.AlreadyExists
54
55 » » object PushProfile(string name)
56
57 » » » Push the profile with the specified identifier
58 » » » onto the profile stack. The profile must have
59 » » » previously been created with CreateProfile.
60 » » » The profile becomes the ``active profile'' that
61 » » » is searched first when loading data and to which
62 » » » updates are stored.
63
64 » » » A profile may be pushed only once.
65
66 » » » Possible Errors: [service].Error.InvalidArguments
67 » » » » » [service].Error.AlreadyExists
68
69 » » object PopProfile(string name)
70
71 » » » Pop the top-most profile on the profile stack.
72 » » » Any profile beneath this profile becomes the
73 » » » ``active profile''. Any services using security
74 » » » settings from the popped profile are disconnected
75 » » » and the credentials invalidated (the next time
76 » » » credentials are needed they are loaded from the
77 » » » (new) active profile).
78
79 » » » The name must match the identifer of the active
80 » » » profile. This is a safeguard against accidentally
81 » » » removing the wrong profile.
82
83 » » » Note it is valid to pop all profiles from the
84 » » » stack; in this state the connection manager does
85 » » » not write any state to persistent storage.
86
87 » » » Possible Errors: [service].Error.InvalidArguments
88 » » » » » [service].Error.NotFound
89
90 » » object PopAnyProfile()
91
92 » » » Like PopProfile but do not check the profile on
93 » » » the top of the stack; pop anything.
36 94
37 Possible Errors: [service].Error.InvalidArguments 95 Possible Errors: [service].Error.InvalidArguments
38 96
39 » » void RemoveProfile(object path) 97 » » void RemoveProfile(string name)
40 98
41 » » » Remove profile with specified object path. 99 » » » Remove profile with specified identifier.
42 100
43 » » » It is not possible to remove the current active 101 » » » The profile may not be resident on the stack.
44 » » » profile. To remove the active profile a different 102 » » » The default profile may not be removed.
45 » » » one must be selected via ActiveProfile property
46 » » » first.
47
48 » » » At minimum one profile must be available all the time.
49 103
50 Possible Errors: [service].Error.InvalidArguments 104 Possible Errors: [service].Error.InvalidArguments
105 [service].Error.AlreadyExists
51 106
52 void RequestScan(string type) 107 void RequestScan(string type)
53 108
54 Request to trigger a scan for the specified 109 Request to trigger a scan for the specified
55 technology. The empty string "" triggers scanning 110 technology. The empty string "" triggers scanning
56 on all technologies. 111 on all technologies.
57 112
58 Possible Errors: [service].Error.InvalidArguments 113 Possible Errors: [service].Error.InvalidArguments
59 114
60 void EnableTechnology(string type) 115 void EnableTechnology(string type)
(...skipping 182 matching lines...) Expand 10 before | Expand all | Expand 10 after
243 array{string} ConnectedTechnologies [readonly] 298 array{string} ConnectedTechnologies [readonly]
244 299
245 The list of connected technologies. The strings 300 The list of connected technologies. The strings
246 are the same as the ones from the service type. 301 are the same as the ones from the service type.
247 302
248 string DefaultTechnology [readonly] 303 string DefaultTechnology [readonly]
249 304
250 The current connected technology which holds the 305 The current connected technology which holds the
251 default route. 306 default route.
252 307
253 » » boolean OfflineMode [readwrite] 308 » » boolean OfflineMode [readonly]
254 309
255 The offline mode indicates the global setting for 310 The offline mode indicates the global setting for
256 switching all radios on or off. Changing offline mode 311 switching all radios on or off. Changing offline mode
257 to true results in powering down all devices. When 312 to true results in powering down all devices. When
258 leaving offline mode the individual policy of each 313 leaving offline mode the individual policy of each
259 device decides to switch the radio back on or not. 314 device decides to switch the radio back on or not.
260 315
261 During offline mode, it is still possible to switch 316 During offline mode, it is still possible to switch
262 certain technologies manually back on. For example 317 certain technologies manually back on. For example
263 the limited usage of WiFi or Bluetooth devices might 318 the limited usage of WiFi or Bluetooth devices might
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
307 order as the "Services" property above, but this 362 order as the "Services" property above, but this
308 property is not considered "changed" if the ordering 363 property is not considered "changed" if the ordering
309 changes. 364 changes.
310 365
311 Changes to this list are batched up for small periods 366 Changes to this list are batched up for small periods
312 of time, so that batches of changes are collected 367 of time, so that batches of changes are collected
313 into a single message containing the final state, and 368 into a single message containing the final state, and
314 ephemeral changes where the list returns to the 369 ephemeral changes where the list returns to the
315 previous state are filtered out. 370 previous state are filtered out.
316 371
OLDNEW
« no previous file with comments | « configure.ac ('k') | doc/profile-api.txt » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698