modules-purge-queues.md

title	layout
Purge Queues Module	api

Purge Queues Module

The PurgeQueuesModule may be found in the Shuttle.Esb.Modules assembly. The module will attach the PurgeQueuesObserver to the OnAfterInitializeQueueFactories event of the StartupPipeline and purges the queues configured in the purgeQueues configuration section:

<configuration>
	<configSections>
		<section name="purgeQueues" type="Shuttle.Esb.Modules.PurgeQueuesSection, Shuttle.Esb.Modules"/>
	</configSections>

	<purgeQueues>
		<queues>
			<queue uri="msmq://./inbox" />
			<queue uri="sql://./inbox" />
		</queues>
	</purgeQueues>
</configuration>

The relevant queue implementation has to implement the IPurgeQueue interface. If it doesn't a warning is logged.

	var bus = ServiceBus
		.Create(c => c.AddModule(new PurgeQueuesModule()))
		.Start();