C# Class Nexus.Client.PluginManagement.OrderLog.PluginOrderLog.TransactionEnlistment

Tracks the changes made to an PluginOrderLog in the scope of a single Transaction. This also provides to mean to commit and rollback the tracked changes.

Inheritance: IEnlistmentNotification

Datei anzeigen Open project: NexusMods/NexusModManager-4.5

Public Methods

Method	Description
Commit ( ) : void	Commits the changes to the PluginOrderLog.
Commit ( Enlistment p_eltEnlistment ) : void	Used to notify an enlisted resource manager that the transaction is being committed.
InDoubt ( Enlistment p_eltEnlistment ) : void	Used to notify an enlisted resource manager that the transaction is in doubt. A transaction is in doubt if it has not received votes from all enlisted resource managers as to the state of the transaciton.
Prepare ( PreparingEnlistment p_entPreparingEnlistment ) : void	Used to notify an enlisted resource manager that the transaction is being prepared for commitment.
RemovePlugin ( Plugin p_plgPlugin ) : void	Removes the given plugin from the order list.
Rollback ( Enlistment p_eltEnlistment ) : void	Used to notify an enlisted resource manager that the transaction is being rolled back.
SetPluginOrder ( IList p_lstOrderedPlugins ) : void	Sets the order of the plugins to the given order. If the given list does not include all registered plugins, then the plugins are ordered in a manner so as to not displace the positions of the plugins whose order was not specified.
TransactionEnlistment ( Transaction p_txTransaction, PluginOrderLog p_polPluginOrderLog ) : System	A simple constructor that initializes the object with the given values.

Private Methods

Method	Description
Enlist ( ) : void	Enlists the install log into the current transaction.
MasterOrderedPlugins_CollectionChanged ( object sender, NotifyCollectionChangedEventArgs e ) : void	Handles the INotifyCollectionChanged.CollectionChanged event of the master list of ordered plugins. This applies any changes that are made to the maser list to the transacted list with which we are currently working.

Method Details

Commit() public method

Commits the changes to the PluginOrderLog.

public Commit ( ) : void
return	void

Commit() public method

Used to notify an enlisted resource manager that the transaction is being committed.

public Commit ( Enlistment p_eltEnlistment ) : void
p_eltEnlistment	Nexus.Transactions.Enlistment	The enlistment class used to communicate with the resource manager.
return	void

InDoubt() public method

Used to notify an enlisted resource manager that the transaction is in doubt.

A transaction is in doubt if it has not received votes from all enlisted resource managers as to the state of the transaciton.

public InDoubt ( Enlistment p_eltEnlistment ) : void
p_eltEnlistment	Nexus.Transactions.Enlistment	The enlistment class used to communicate with the resource manager.
return	void

Prepare() public method

Used to notify an enlisted resource manager that the transaction is being prepared for commitment.

public Prepare ( PreparingEnlistment p_entPreparingEnlistment ) : void
p_entPreparingEnlistment	Nexus.Transactions.PreparingEnlistment	The enlistment class used to communicate with the resource manager.
return	void

RemovePlugin() public method

Removes the given plugin from the order list.

public RemovePlugin ( Plugin p_plgPlugin ) : void
p_plgPlugin	Nexus.Client.Plugins.Plugin	The plugin to remove from the order list.
return	void

Rollback() public method

Used to notify an enlisted resource manager that the transaction is being rolled back.

public Rollback ( Enlistment p_eltEnlistment ) : void
p_eltEnlistment	Nexus.Transactions.Enlistment	The enlistment class used to communicate with the resource manager.
return	void

SetPluginOrder() public method

Sets the order of the plugins to the given order.

If the given list does not include all registered plugins, then the plugins are ordered in a manner so as to not displace the positions of the plugins whose order was not specified.

public SetPluginOrder ( IList p_lstOrderedPlugins ) : void
p_lstOrderedPlugins	IList	The list indicating the desired order of the plugins.
return	void

TransactionEnlistment() public method

A simple constructor that initializes the object with the given values.

public TransactionEnlistment ( Transaction p_txTransaction, PluginOrderLog p_polPluginOrderLog ) : System
p_txTransaction	Nexus.Transactions.Transaction	The transaction into which we are enlisting.
p_polPluginOrderLog	PluginOrderLog	The whose actions are being transacted.
return	System