NetworkManager/src/settings/plugins/example
Dan Winship d13bfe3cf8 settings: drop plugin-specific error domains
Each plugin defined its own error domain, though none actually defined
any errors. Replace these with appropriate uses of
NM_SETTINGS_ERROR_INVALID_CONNECTION and NM_SETTINGS_ERROR_FAILED.
2014-10-22 08:29:09 -04:00
..
common.h settings: drop plugin-specific error domains 2014-10-22 08:29:09 -04:00
Makefile.am settings: drop plugin-specific error domains 2014-10-22 08:29:09 -04:00
nm-example-connection.c settings: drop plugin-specific error domains 2014-10-22 08:29:09 -04:00
nm-example-connection.h all: fix up multiple-include-guard defines 2014-08-16 10:17:14 -04:00
plugin.c libnm-core: drop nm_setting_lookup_type_by_quark() 2014-10-22 08:29:07 -04:00
plugin.h core: fix NM_IS_*_CLASS(klass) macros 2012-07-27 13:15:54 +02:00
reader.c libnm: rename NetworkManager.h and NetworkManagerVPN.h 2014-08-01 14:34:40 -04:00
README examples: add an example system settings plugin 2012-05-07 15:19:09 -05:00
writer.c trivial: fix spelling errors in code comments and README file 2013-08-06 13:48:02 -05:00

Plugins generally have three components:

1) plugin object: manages the individual "connections", which are
  just objects wrapped around on-disk config data.  The plugin handles requests
  to add new connections via the NM D-Bus API, and also watches config
  directories for changes to configuration data.  It also handles reading and
  writing the persistent hostname, if the plugin supports hostnames.  Plugins
  implement the NMSystemConfigInterface interface.  See plugin.c.

2) "connections": subclasses of NMSettingsConnection.  They handle updates to
  configuration data, deletion, etc.  See NMExampleConnection.c.

3) reader/writer code: typically a separate static library that gets linked
  into the main plugin shared object, so they can be unit tested separately
  from the plugin.  This code should read config data from disk and create
  an NMConnection from it, and be capable of taking an NMConnection and writing
  out appropriate configuration data to disk.

NM will first call the "factory" function that every module must provide, which
is nm_system_config_factory().  That function creates and returns a singleton
instance of the plugin's main object, which implements NMSystemConfigInterface.
That interface is implemented via the object definition in G_DEFINE_TYPE_EXTENDED
in plugin.c, which registers the interface setup function
system_config_interface_init(), which when called actually sets up the vtables
for the functions defined by NMSystemConfigInterface.  Thus there are two
entry points into the plugin:  nm_system_config_factory() and
the NMSystemConfigInterface methods.

The plugin also emits various signals (defined by NMSystemConfigInterface)
which NetworkManager listens for.  These include persistent hostname changes
(if something modified the file in which the persistent hostname is stored)
and notifications of new connections if they were created via changes to
the on-disk files.  The "connection" objects can also emit signals
(defined by the NMSettingsConnection and NMConnection superclasses) when the
connections' backing storage gets changed or deleted.