MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT

#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT   0

MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING

#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING   10000

MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL

#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL    100

MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY

#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY -1

McpAccountStorageCommitFunc ()

gboolean            (*McpAccountStorageCommitFunc)      (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

McpAccountStorageCommitOneFunc ()

gboolean            (*McpAccountStorageCommitOneFunc)   (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account);

McpAccountStorageCreate ()

gchar *             (*McpAccountStorageCreate)          (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *manager,
                                                         const gchar *protocol,
                                                         GHashTable *params,
                                                         GError **error);

McpAccountStorageDeleteFunc ()

gboolean            (*McpAccountStorageDeleteFunc)      (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key);

McpAccountStorageGetAdditionalInfoFunc ()

GHashTable *        (*McpAccountStorageGetAdditionalInfoFunc)
                                                        (const McpAccountStorage *storage,
                                                         const gchar *account);

McpAccountStorageGetFunc ()

gboolean            (*McpAccountStorageGetFunc)         (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key);

McpAccountStorageGetIdentifierFunc ()

void                (*McpAccountStorageGetIdentifierFunc)
                                                        (const McpAccountStorage *storage,
                                                         const gchar *account,
                                                         GValue *identifier);

McpAccountStorageGetRestrictionsFunc ()

guint               (*McpAccountStorageGetRestrictionsFunc)
                                                        (const McpAccountStorage *storage,
                                                         const gchar *account);

struct McpAccountStorageIface

struct McpAccountStorageIface {
  GTypeInterface parent;

  gint priority;
  const gchar *name;
  const gchar *desc;
  const gchar *provider;

  McpAccountStorageSetFunc set;
  McpAccountStorageGetFunc get;
  McpAccountStorageDeleteFunc delete;
  McpAccountStorageCommitFunc commit;
  McpAccountStorageListFunc list;
  McpAccountStorageReadyFunc ready;
  McpAccountStorageCommitOneFunc commit_one;
  McpAccountStorageGetIdentifierFunc get_identifier;
  McpAccountStorageGetAdditionalInfoFunc get_additional_info;
  McpAccountStorageGetRestrictionsFunc get_restrictions;
  McpAccountStorageCreate create;
};

McpAccountStorageListFunc ()

GList *             (*McpAccountStorageListFunc)        (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

McpAccountStorageReadyFunc ()

void                (*McpAccountStorageReadyFunc)       (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

McpAccountStorageSetFunc ()

gboolean            (*McpAccountStorageSetFunc)         (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key,
                                                         const gchar *val);

mcp_account_storage_commit ()

gboolean            mcp_account_storage_commit          (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

The plugin is expected to write its cache to long term storage, deleting, adding or updating entries in said storage as needed.

This call is expected to return promptly, but the plugin is not required to have finished its commit operation when it returns, merely to have started the operation.

If the commit_one method is implemented, it will be called preferentially if only one account is to be committed. If the commit_one method is implemented but commit is not, commit_one will be called with account_name = NULL to commit all accounts.

mcp_account_storage_commit_one ()

gboolean            mcp_account_storage_commit_one      (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account);

The same as mcp_account_storage_commit(), but only commit the given account. This is optional to implement; the default implementation is to call commit.

mcp_account_storage_create ()

gchar *             mcp_account_storage_create          (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *manager,
                                                         const gchar *protocol,
                                                         GHashTable *params,
                                                         GError **error);

Inform the plugin that a new account is being created. manager, protocol and params are given to help determining the account's unique name, but does not need to be stored on the account yet, mcp_account_storage_set() and mcp_account_storage_commit() will be called later.

It is recommended to use mcp_account_manager_get_unique_name() to create the unique name, but it's not mandatory. One could base the unique name on an internal storage identifier, prefixed with the provider's name (e.g. goa__1234).

"created" signal should not be emitted for this account, not even when mcp_account_storage_commit() will be called.

mcp_account_storage_delete ()

gboolean            mcp_account_storage_delete          (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key);

The plugin is expected to remove the setting for key from its internal cache and to remember that its state has changed, so that it can delete said setting from its long term storage if its long term storage method makes this necessary.

If key is NULL, the plugin should forget all its settings for account (and remember to delete account from its storage later)

The plugin is not expected to update its long term storage at this point.

mcp_account_storage_description ()

const gchar *       mcp_account_storage_description     (const McpAccountStorage *storage);

mcp_account_storage_emit_altered ()

void                mcp_account_storage_emit_altered    (McpAccountStorage *storage,
                                                         const gchar *account);

Emits ::altered signal

mcp_account_storage_emit_altered_one ()

void                mcp_account_storage_emit_altered_one
                                                        (McpAccountStorage *storage,
                                                         const gchar *account,
                                                         const gchar *key);

Emits ::created-one signal

mcp_account_storage_emit_created ()

void                mcp_account_storage_emit_created    (McpAccountStorage *storage,
                                                         const gchar *account);

mcp_account_storage_emit_deleted ()

void                mcp_account_storage_emit_deleted    (McpAccountStorage *storage,
                                                         const gchar *account);

Emits ::deleted signal

mcp_account_storage_emit_reconnect ()

void                mcp_account_storage_emit_reconnect  (McpAccountStorage *storage,
                                                         const gchar *account);

Emits ::reconnect signal

mcp_account_storage_emit_toggled ()

void                mcp_account_storage_emit_toggled    (McpAccountStorage *storage,
                                                         const gchar *account,
                                                         gboolean enabled);

Emits ::toggled signal

mcp_account_storage_get ()

gboolean            mcp_account_storage_get             (const McpAccountStorage *storage,
                                                         McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key);

The plugin is expected to quickly and synchronously update the value associated with key using calls to am.

The plugin is not required to consult whatever long term storage it uses, and may fetch said value from its internal cache, if any.

If key is NULL the plugin should write all its settings for account into the account manager via am. The return value in this case should be TRUE if any settings were found.

mcp_account_storage_get_additional_info ()

GHashTable *        mcp_account_storage_get_additional_info
                                                        (const McpAccountStorage *storage,
                                                         const gchar *account);

Return additional storage-specific information about this account, which is made available on D-Bus but not otherwise interpreted by Mission Control.

mcp_account_storage_get_identifier ()

void                mcp_account_storage_get_identifier  (const McpAccountStorage *storage,
                                                         const gchar *account,
                                                         GValue *identifier);

Get the storage-specific identifier for this account. The type is variant, hence the GValue.

mcp_account_storage_get_restrictions ()

guint               mcp_account_storage_get_restrictions
                                                        (const McpAccountStorage *storage,
                                                         const gchar *account);

mcp_account_storage_iface_implement_commit ()

void                mcp_account_storage_iface_implement_commit
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageCommitFunc method);

mcp_account_storage_iface_implement_commit_one ()

void                mcp_account_storage_iface_implement_commit_one
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageCommitOneFunc method);

mcp_account_storage_iface_implement_create ()

void                mcp_account_storage_iface_implement_create
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageCreate method);

mcp_account_storage_iface_implement_delete ()

void                mcp_account_storage_iface_implement_delete
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageDeleteFunc method);

mcp_account_storage_iface_implement_get ()

void                mcp_account_storage_iface_implement_get
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageGetFunc method);

mcp_account_storage_iface_implement_get_additional_info ()

void                mcp_account_storage_iface_implement_get_additional_info
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageGetAdditionalInfoFunc method);

mcp_account_storage_iface_implement_get_identifier ()

void                mcp_account_storage_iface_implement_get_identifier
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageGetIdentifierFunc method);

mcp_account_storage_iface_implement_get_restrictions ()

void                mcp_account_storage_iface_implement_get_restrictions
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageGetRestrictionsFunc method);

mcp_account_storage_iface_implement_list ()

void                mcp_account_storage_iface_implement_list
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageListFunc method);

mcp_account_storage_iface_implement_ready ()

void                mcp_account_storage_iface_implement_ready
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageReadyFunc method);

mcp_account_storage_iface_implement_set ()

void                mcp_account_storage_iface_implement_set
                                                        (McpAccountStorageIface *iface,
                                                         McpAccountStorageSetFunc method);

mcp_account_storage_iface_set_desc ()

void                mcp_account_storage_iface_set_desc  (McpAccountStorageIface *iface,
                                                         const gchar *desc);

mcp_account_storage_iface_set_name ()

void                mcp_account_storage_iface_set_name  (McpAccountStorageIface *iface,
                                                         const gchar *name);

mcp_account_storage_iface_set_priority ()

void                mcp_account_storage_iface_set_priority
                                                        (McpAccountStorageIface *iface,
                                                         guint prio);

mcp_account_storage_iface_set_provider ()

void                mcp_account_storage_iface_set_provider
                                                        (McpAccountStorageIface *iface,
                                                         const gchar *provider);

mcp_account_storage_list ()

GList *             mcp_account_storage_list            (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

This method is called only at initialisation time, before the dbus name has been claimed, and is the only one permitted to block.

mcp_account_storage_name ()

const gchar *       mcp_account_storage_name            (const McpAccountStorage *storage);

mcp_account_storage_priority ()

gint                mcp_account_storage_priority        (const McpAccountStorage *storage);

Gets the priority for this plugin.

Priorities currently run from MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT (the default storage plugin priority) upwards.

Plugins at a higher priority then MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING will have the opportunity to "steal" passwords from the gnome keyring: Plugins at a lower priority than this will not receive secret parameters from MC as the keyring plugin will already have claimed them.

Plugins at a lower priority than the default plugin will never be asked to store any details, although they may still be asked to list them at startup time, and may asynchronously notify MC of accounts via the signals above.

When loading accounts at startup, plugins are consulted in order from lowest to highest, so that higher priority plugins may overrule settings from lower priority plugins.

Loading all the accounts is only done at startup, before the dbus name is claimed, and is therefore the only time plugins are allowed to indulge in blocking calls (indeed, they are expected to carry out this operation, and ONLY this operation, synchronously).

When values are being set, the plugins are invoked from highest priority to lowest, with the first plugin that claims a setting being assigned ownership, and all lower priority plugins being asked to delete the setting in question.

mcp_account_storage_provider ()

const gchar *       mcp_account_storage_provider        (const McpAccountStorage *storage);

mcp_account_storage_ready ()

void                mcp_account_storage_ready           (const McpAccountStorage *storage,
                                                         const McpAccountManager *am);

Informs the plugin that it is now permitted to create new accounts, ie it can now fire its "created", "altered", "toggled" and "deleted" signals.

mcp_account_storage_set ()

gboolean            mcp_account_storage_set             (const McpAccountStorage *storage,
                                                         const McpAccountManager *am,
                                                         const gchar *account,
                                                         const gchar *key,
                                                         const gchar *value);

The plugin is expected to either quickly and synchronously update its internal cache of values with value, or to decline to store the setting.

The plugin is not expected to write to its long term storage at this point.