This class provides base features for all message senders and includes a logger. Subclasses do not have to log when delivery starts and stops. More...

Inheritance diagram for Apac.Messaging.Handlers.MessageHandler:

Public Member Functions
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
	MessageHandler ()
	Creates a new MessageHandler. More...

abstract DeliveryStatus	OnDeliver (Message message, MessagingAddress sender, IEnumerable< MessagingAddress > recipients)
	When overridden by subclasses this method should deliver the message according to SupportedProtocol and return an appropriate DeliveryStatus. More...

Properties
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 provides base features for all message senders and includes a logger. Subclasses do not have to log when delivery starts and stops.

Constructor & Destructor Documentation

◆ MessageHandler()

Apac.Messaging.Handlers.MessageHandler.MessageHandler ( )

inlineprotected

Creates a new MessageHandler.

Member Function Documentation

◆ Deliver()

DeliveryStatus Apac.Messaging.Handlers.MessageHandler.Deliver	(	Message	message,
		MessagingAddress	sender,
		IEnumerable< MessagingAddress >	recipients
	)

inline

Delivers the message according to the message contents and the system's configured messaging participants.

Parameters

message	The message to be sent.
sender	The participant sending the message.
recipients	The participants receiving the message.

Returns: Returns a DeliveryStatus indicating how the delivery went.

Implements Apac.Messaging.IMessageHandler.

◆ OnDeliver()

abstract DeliveryStatus Apac.Messaging.Handlers.MessageHandler.OnDeliver	(	Message	message,
		MessagingAddress	sender,
		IEnumerable< MessagingAddress >	recipients
	)

protectedpure virtual

When overridden by subclasses this method should deliver the message according to SupportedProtocol and return an appropriate DeliveryStatus.

Parameters

message	The message to be sent.
sender	The participant sending the message.
recipients	The participants receiving the message.

Returns: Returns a DeliveryStatus indicating how the delivery went.

Implemented in Apac.Messaging.Handlers.SmtpMessageHandler, and Apac.Messaging.Handlers.ConfigurationMessageHandler.

Property Documentation

◆ Log

log4net.ILog Apac.Messaging.Handlers.MessageHandler.Log

getprotected

Internaly accessible logger.

◆ SupportedProtocol

abstract MessagingProtocols Apac.Messaging.Handlers.MessageHandler.SupportedProtocol

get

When overridden by subclasses, this property indicates the single protocol supported by the message handler.

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

/var/lib/jenkins/workspace/apac/APAC/APACCore/Messaging/Handlers/MessageHandler.cs

Public Member Functions

Protected Member Functions

Properties