diff options
| author | Dan Williams <dcbw@redhat.com> | 2013-04-10 13:49:02 -0500 |
|---|---|---|
| committer | Dan Williams <dcbw@redhat.com> | 2013-04-10 14:21:34 -0500 |
| commit | b62a3abbffe5a1d5abf1db8f1d61b7d32fb7824b (patch) | |
| tree | 1c27283ff341460f4fb639fdbe6918579bf82b3e /introspection/nm-settings.xml | |
| parent | 6701181c358db34d77ec553fb01ea51705862485 (diff) | |
| download | NetworkManager-b62a3abbffe5a1d5abf1db8f1d61b7d32fb7824b.tar.gz | |
api: update Settings documentation to explain NewConnection signal timing (bgo #697742)
Diffstat (limited to 'introspection/nm-settings.xml')
| -rw-r--r-- | introspection/nm-settings.xml | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/introspection/nm-settings.xml b/introspection/nm-settings.xml index 301cde76dd..c791466843 100644 --- a/introspection/nm-settings.xml +++ b/introspection/nm-settings.xml @@ -8,7 +8,7 @@ <method name="ListConnections"> <tp:docstring> - List the connections stored by this Settings object. + List the saved network connections known to NetworkManager. </tp:docstring> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_list_connections"/> <arg name="connections" type="ao" direction="out"> @@ -37,7 +37,10 @@ <method name="AddConnection"> <tp:docstring> - Add new connection. + Add new connection and save it to disk. This operation does not start + the network connection unless (1) device is idle and able to connect to + the network described by the new connection, and (2) the connection + is allowed to be started automatically. </tp:docstring> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_add_connection"/> <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> @@ -88,7 +91,14 @@ <signal name="NewConnection"> <tp:docstring> - Emitted when a new connection has been added. + Emitted when a new connection has been added after NetworkManager has + started up and initialized. This signal is not emitted for connections + read while starting up, because NetworkManager's D-Bus service is only + available after all connections have been read, and to prevent spamming + listeners with too many signals at one time. To retrieve the initial + connection list, call the ListConnections() method once, and then listen + for individual Settings.NewConnection and Settings.Connection.Deleted + signals for further updates. </tp:docstring> <arg name="connection" type="o"> <tp:docstring> |