Class MessageSink
Base for ALL implementations that work under MailerService
Inheritance
System.Object
MessageSink
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Web.Messaging
Assembly: NFX.Web.dll
Syntax
public abstract class MessageSink : ServiceWithInstrumentationBase<MessageService>, IApplicationComponent, IDisposable, IService, INamed, ILocalizedTimeProvider, IInstrumentable, IExternallyParameterized, IMessageSink, IConfigurable
Constructors
MessageSink(MessageService)
Declaration
protected MessageSink(MessageService director)
Parameters
Type | Name | Description |
---|---|---|
MessageService | director |
Properties
ErrorHandlingMode
Declaration
[Config]
[ExternalParameter(new string[]{"messaging"})]
public SendMessageErrorHandling ErrorHandlingMode { get; set; }
Property Value
Type | Description |
---|---|
SendMessageErrorHandling |
InstrumentationEnabled
Declaration
[Config]
[ExternalParameter(new string[]{"messaging", "instrumentation"})]
public override bool InstrumentationEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
NFX.ServiceModel.ServiceWithInstrumentationBase<NFX.Web.Messaging.MessageService>.InstrumentationEnabled
SupportedChannelNames
Declaration
public virtual IEnumerable<string> SupportedChannelNames { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
SupportedChannels
Declaration
public abstract MsgChannels SupportedChannels { get; }
Property Value
Type | Description |
---|---|
MsgChannels |
Methods
DoSendMsg(Message)
Performs actual sending of msg. This method does not have to be thread-safe as it is called by a single thread
Declaration
protected abstract bool DoSendMsg(Message msg)
Parameters
Type | Name | Description |
---|---|---|
Message | msg |
Returns
Type | Description |
---|---|
System.Boolean |
Filter(Message)
Declaration
protected virtual bool Filter(Message msg)
Parameters
Type | Name | Description |
---|---|---|
Message | msg |
Returns
Type | Description |
---|---|
System.Boolean |
Log(MessageType, String, String, Exception, Nullable<Guid>, String)
Declaration
protected Guid Log(MessageType type, string from, string message, Exception error = null, Guid? relatedMessageID = default (Guid? ), string parameters = null)
Parameters
Type | Name | Description |
---|---|---|
MessageType | type | |
System.String | from | |
System.String | message | |
System.Exception | error | |
System.Nullable<System.Guid> | relatedMessageID | |
System.String | parameters |
Returns
Type | Description |
---|---|
System.Guid |
SendMsg(Message)
Performs actual sending of msg. This method does not have to be thread-safe as it is called by a single thread
Declaration
public bool SendMsg(Message msg)
Parameters
Type | Name | Description |
---|---|---|
Message | msg |
Returns
Type | Description |
---|---|
System.Boolean |
Implements
System.IDisposable