# IDispatcherQueueManagerService
`IDispatcherQueueManagerService` in assembly SanteDB.Core.Api version 3.0.1980.0
## Summary
A service which is responsible for storing messages in a reliable place for dispatching
### Description
Whenever SanteDB sends messages to another system using messaging, there is no guarantee that the remote endpoint will be available, or accessable, etc. Therefore all messages which are sent (dispatched) to a remote system are first queued using this wrapper service.
The purpose of the dispatcher queue is the store the outbound message locally in some persistent place, then to notify any listeners that a new message is ready for sending. If the message cannot be sent, then the sending service should place the message back onto the queue or onto a dedicated deadletter queue.
## Operations
| Operation | Response/Return | Input/Parameter | Description |
| --------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| Open | void | *String* **queueName** | Opens the specified queue name and enables subscriptions |
| SubscribeTo | void | String queueName
DispatcherQueueCallback callback
| Subscribes to using |
| UnSubscribe | void | String queueName
DispatcherQueueCallback callback
| Remove the callback registration |
| Enqueue | void | String queueName
Object data
| Enqueue the specified data to the persistent queue |
| Dequeue | DispatcherQueueEntry | *String* **queueName** | Dequeues the last added item from the persistent queue |
| DequeueById | DispatcherQueueEntry | String queueName
String correlationId
| De-queue a specific message |
| Purge | void | *String* **queueName** | Purge the queue |
| Move | DispatcherQueueEntry | DispatcherQueueEntry entry
String toQueue
| Move an entry from one queue to another |
| GetQueueEntry | DispatcherQueueEntry | String queueName
String correlationId
| Get the specified queue entry |
| GetQueues | IEnumerable\ | *none* | TODO |
| GetQueueEntries | IEnumerable\ | *String* **queueName** | Get all queue entries |
## Implementations
### FileSystemDispatcherQueueService - (SanteDB.Core.Api)
A persistent queue service that uses the file system (use when there's no other infrastructure)
#### Service Registration
```markup
...
...
...
```
### MsmqPersistentQueueService - (SanteDB.Queue.Msmq)
TODO: Document this
#### Service Registration
```markup
...
...
...
```
### RabbitMqService - (SanteDB.Queue.RabbitMq)
An implementation of the [IDispatcherQueueManagerService](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Queue_IDispatcherQueueManagerService.htm) which uses RabbitMQ as the queue managing service
#### Description
This queue service uses RabbitMQ to manage queues and loading/unloading of items to queues.
#### Service Registration
```markup
...
...
...
```
## Example Implementation
```csharp
/// Example Implementation
using SanteDB.Core.Queue;
/// Other usings here
public class MyDispatcherQueueManagerService : SanteDB.Core.Queue.IDispatcherQueueManagerService {
public String ServiceName => "My own IDispatcherQueueManagerService service";
///
/// Opens the specified queue name and enables subscriptions
///
public void Open(String queueName){
throw new System.NotImplementedException();
}
///
/// Subscribes to using
///
public void SubscribeTo(String queueName,DispatcherQueueCallback callback){
throw new System.NotImplementedException();
}
///
/// Remove the callback registration
///
public void UnSubscribe(String queueName,DispatcherQueueCallback callback){
throw new System.NotImplementedException();
}
///
/// Enqueue the specified data to the persistent queue
///
public void Enqueue(String queueName,Object data){
throw new System.NotImplementedException();
}
///
/// Dequeues the last added item from the persistent queue
///
public DispatcherQueueEntry Dequeue(String queueName){
throw new System.NotImplementedException();
}
///
/// De-queue a specific message
///
public DispatcherQueueEntry DequeueById(String queueName,String correlationId){
throw new System.NotImplementedException();
}
///
/// Purge the queue
///
public void Purge(String queueName){
throw new System.NotImplementedException();
}
///
/// Move an entry from one queue to another
///
public DispatcherQueueEntry Move(DispatcherQueueEntry entry,String toQueue){
throw new System.NotImplementedException();
}
///
/// Get the specified queue entry
///
public DispatcherQueueEntry GetQueueEntry(String queueName,String correlationId){
throw new System.NotImplementedException();
}
public IEnumerable GetQueues(){
throw new System.NotImplementedException();
}
///
/// Get all queue entries
///
public IEnumerable GetQueueEntries(String queueName){
throw new System.NotImplementedException();
}
}
```
## References
* [IDispatcherQueueManagerService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Queue_IDispatcherQueueManagerService.htm)
* [Persistent queue service using a file system directory for storage C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Services_Impl_FileSystemDispatcherQueueService.htm)
* [MsmqPersistentQueueService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Queue_Msmq_MsmqPersistentQueueService.htm)
* [RabbitMqService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Queue_RabbitMq_RabbitMqService.htm)
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://help.santesuite.org/developers/server-plugins/implementing-.net-features/service-definitions/idispatcherqueuemanagerservice.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.