NetworkManager/src/settings/plugins
Thomas Haller 9558560862 ifcfg-rh: refactor construction of plugin instance and acquiring D-Bus service
Move code from sc_plugin_ifcfg_init() and nm_system_config_factory()
to constructed().
2015-08-13 10:06:42 +02:00
..
ibft core: final gdbus porting 2015-08-10 09:41:26 -04:00
ifcfg-rh ifcfg-rh: refactor construction of plugin instance and acquiring D-Bus service 2015-08-13 10:06:42 +02:00
ifnet core: final gdbus porting 2015-08-10 09:41:26 -04:00
ifupdown core: final gdbus porting 2015-08-10 09:41:26 -04:00
keyfile keyfile: don't have static @singleton in nm_settings_keyfile_plugin_new() 2015-08-13 10:06:42 +02:00
Makefile.am settings/example: remove 'example' settings plugin 2015-06-12 15:59:40 +02:00
README settings/example: remove 'example' settings plugin 2015-06-12 15:59:40 +02: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.  Plugins implement the
  NMSystemConfigInterface interface.  See plugin.c.

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

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 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.