Message Installer Queue
Message Installer Queue
Message Installer Queue
Allows you to install and configure a queue that your application needs in order to run. This class is called by the installation utility, for example, InstallUtil.exe, when installing a MessageQueue.
public ref class MessageQueueInstaller : System::Configuration::Install::ComponentInstaller
public class MessageQueueInstaller : System.Configuration.Install.ComponentInstaller
type MessageQueueInstaller = class inherit ComponentInstaller
Public Class MessageQueueInstaller Inherits ComponentInstaller
The MessageQueueInstaller is used by the installation utility to write registry values that are associated with the queue. For more information about installation utilities, see Installutil.exe (Installer Tool).
To install a queue, create a project installer class that inherits from the Installer, and set the RunInstallerAttribute for the class to
true. Within your project, create a MessageQueueInstaller instance for each queue in the installation and add the instance to your project installer class.
When creating a MessageQueueInstaller instance, you can optionally pass an existing MessageQueue (for example, from a test server) to the MessageQueueInstaller constructor. This approach automatically provides the configuration settings for the new queue by mirroring the settings of the queue passed in. Alternatively, you can manually set the properties in the MessageQueueInstaller instance to the states you want and call the default constructor.
When the install utility is called, it looks for the RunInstallerAttribute. If it is
true, the utility installs all the queues in the Installers collection associated with your project installer. If RunInstallerAttribute is
false, the utility ignores the project installer.
You modify other properties of a MessageQueueInstaller instance either before or after adding the instance to the Installers collection of your project installer. For example, a queue's Path must be set before the install utility executes.
Typically, you do not call the methods of the MessageQueueInstaller from within your code; they are generally called only by the installutil.exe installation utility. The utility automatically calls the Install method during the installation process and calls Commit if the installation did not throw an exception. It backs out failures, if necessary, by calling Rollback for the object that generated the exception.
An application's install routine uses the project installer's Installer.Context to automatically maintain information about the components that have already been installed. This state information is continuously updated as each MessageQueueInstaller instance is installed by the utility. It is not usually necessary for your code to explicitly modify the state information.
|MessageQueueInstaller() MessageQueueInstaller() MessageQueueInstaller() MessageQueueInstaller()||
Initializes a new instance of the MessageQueueInstaller class. Does not set any instance properties.
|MessageQueueInstaller(MessageQueue) MessageQueueInstaller(MessageQueue) MessageQueueInstaller(MessageQueue) MessageQueueInstaller(MessageQueue)|
|Authenticate Authenticate Authenticate Authenticate||
Gets or sets a value that indicates whether the queue to be installed accepts only authenticated messages.
|BasePriority BasePriority BasePriority BasePriority||
Gets or sets the base priority that is used to route a public queue's messages over the network.
|CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents||
Gets a value indicating whether the component can raise an event.(Inherited from Component)
|Category Category Category Category||
Gets or sets an implementation-specific queue type.
|Container Container Container Container||Component)|
|Context Context Context Context||
Gets or sets information about the current installation.(Inherited from Installer)
|DesignMode DesignMode DesignMode DesignMode||
Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component)
|EncryptionRequired EncryptionRequired EncryptionRequired EncryptionRequired||
Gets or sets a value that indicates whether the queue accepts only private, or encrypted, messages.
|Events Events Events Events||
Gets the list of event handlers that are attached to this Component.(Inherited from Component)
|HelpText HelpText HelpText HelpText||
Gets the help text for all the installers in the installer collection.(Inherited from Installer)
|Installers Installers Installers Installers||
Gets the collection of installers that this installer contains.(Inherited from Installer)
|Label Label Label Label||
Gets or sets a description of the queue.
|MaximumJournalSize MaximumJournalSize MaximumJournalSize MaximumJournalSize||
Gets or sets the maximum size of the journal that is associated with the queue.
|MaximumQueueSize MaximumQueueSize MaximumQueueSize MaximumQueueSize||
Gets or sets the maximum size of the queue.
|MulticastAddress MulticastAddress MulticastAddress MulticastAddress||
Introduced in MSMQ 3.0. Gets or sets the multicast address associated with the queue.
|Parent Parent Parent Parent||
Gets or sets the installer containing the collection that this installer belongs to.(Inherited from Installer)
|Path Path Path Path||
Gets or sets the location of the queue that is referenced by this object.
|Permissions Permissions Permissions Permissions||
Gets or sets permissions associated with the queue.
|Site Site Site Site||Component)|
|Transactional Transactional Transactional Transactional||
Gets or sets a value that indicates whether the queue accepts only messages sent as part of a transaction.
|UninstallAction UninstallAction UninstallAction UninstallAction||
Gets or sets a value that indicates what the installer does with the queue at uninstall time: remove it, restore it to its pre-installation state, or leave it in its current installed state.
|UseJournalQueue UseJournalQueue UseJournalQueue UseJournalQueue||
Gets or sets a value that indicates whether messages that are retrieved from the queue are also copied to the associated journal queue.
|AfterInstall AfterInstall AfterInstall AfterInstall||Installer)|
|AfterRollback AfterRollback AfterRollback AfterRollback||
Occurs after the installations of all the installers in the Installers property are rolled back.(Inherited from Installer)
|AfterUninstall AfterUninstall AfterUninstall AfterUninstall||
Occurs after all the installers in the Installers property perform their uninstallation operations.(Inherited from Installer)
|BeforeInstall BeforeInstall BeforeInstall BeforeInstall||
Occurs before the Install(IDictionary) method of each installer in the installer collection has run.(Inherited from Installer)
|BeforeRollback BeforeRollback BeforeRollback BeforeRollback||
Occurs before the installers in the Installers property are rolled back.(Inherited from Installer)
|BeforeUninstall BeforeUninstall BeforeUninstall BeforeUninstall||
Occurs before the installers in the Installers property perform their uninstall operations.(Inherited from Installer)
|Committed Committed Committed Committed||
Occurs after all the installers in the Installers property have committed their installations.(Inherited from Installer)
|Committing Committing Committing Committing||
Occurs before the installers in the Installers property commit their installations.(Inherited from Installer)
|Disposed Disposed Disposed Disposed||
Occurs when the component is disposed by a call to the Dispose() method.(Inherited from Component)