AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Messaging.Handlers.ConfigurationMessageHandler Class Reference

This class implements the logic for configuring the messaging system based on special messages sent to the configuration queue. More...

Inheritance diagram for Apac.Messaging.Handlers.ConfigurationMessageHandler:
Apac.Messaging.Handlers.MessageHandler Apac.Messaging.IMessageHandler

Public Member Functions

 ConfigurationMessageHandler ()
 Creates a new ConfigurationMessageHandler. More...
 
- Public Member Functions inherited from Apac.Messaging.Handlers.MessageHandler
DeliveryStatus Deliver (Message message, MessagingAddress sender, IEnumerable< MessagingAddress > recipients)
 Delivers the message according to the message contents and the system's configured messaging participants. More...
 

Protected Member Functions

override DeliveryStatus OnDeliver (Message message, MessagingAddress sender, IEnumerable< MessagingAddress > recipients)
 Handles the processing (delivery) of the configuration message. The trick here is that the message subject is overloaded to hold the operation to be performed and the message body is overloaded to hold the target info for the operation. More...
 
- Protected Member Functions inherited from Apac.Messaging.Handlers.MessageHandler
 MessageHandler ()
 Creates a new MessageHandler. More...
 

Properties

override MessagingProtocols SupportedProtocol [get]
 A meaningless value in this context. More...
 
- Properties inherited from Apac.Messaging.Handlers.MessageHandler
abstract MessagingProtocols SupportedProtocol [get]
 When overridden by subclasses, this property indicates the single protocol supported by the message handler. More...
 
log4net.ILog Log [get]
 Internaly accessible logger. More...
 
- Properties inherited from Apac.Messaging.IMessageHandler
MessagingProtocols SupportedProtocol [get]
 Gets the MessagingProtocols implemented by the handler. More...
 

Detailed Description

This class implements the logic for configuring the messaging system based on special messages sent to the configuration queue.

Constructor & Destructor Documentation

◆ ConfigurationMessageHandler()

Apac.Messaging.Handlers.ConfigurationMessageHandler.ConfigurationMessageHandler ( )
inline

Member Function Documentation

◆ OnDeliver()

override DeliveryStatus Apac.Messaging.Handlers.ConfigurationMessageHandler.OnDeliver ( Message  message,
MessagingAddress  sender,
IEnumerable< MessagingAddress recipients 
)
inlineprotectedvirtual

Handles the processing (delivery) of the configuration message. The trick here is that the message subject is overloaded to hold the operation to be performed and the message body is overloaded to hold the target info for the operation.

Parameters
messageThe control message to be handled.
senderThe address of the sender - not applicable since these messages are never delivered anywhere.
recipientsThe address list of the recipients, - not applicable since these messages are never delivered anywhere.
Returns
Returns a DeliveryStatus indicating how the operation went.

Implements Apac.Messaging.Handlers.MessageHandler.

Property Documentation

◆ SupportedProtocol

override MessagingProtocols Apac.Messaging.Handlers.ConfigurationMessageHandler.SupportedProtocol
get

A meaningless value in this context.


The documentation for this class was generated from the following file: