Show / Hide Table of Contents

Class MessageSink

Base for ALL implementations that work under MailerService

Inheritance
System.Object
DisposableObject
ApplicationComponent
Service
Service<MessageService>
ServiceWithInstrumentationBase<MessageService>
MessageSink
CompositeMessageSink
MailgunMailerSink
NOPMessageSink
SMTPMessageSink
TwilioSink
Implements
IApplicationComponent
System.IDisposable
IService
INamed
ILocalizedTimeProvider
IInstrumentable
IExternallyParameterized
IMessageSink
IConfigurable
Inherited Members
ServiceWithInstrumentationBase<MessageService>.ExternalParameters
ServiceWithInstrumentationBase<MessageService>.ExternalParametersForGroups(String[])
ServiceWithInstrumentationBase<MessageService>.ExternalGetParameter(String, Object, String[])
ServiceWithInstrumentationBase<MessageService>.ExternalSetParameter(String, Object, String[])
Service<MessageService>.ComponentDirector
Service.CONFIG_NAME_ATTR
Service.Destructor()
Service.ApplicationDontAutoStartService
Service.Status
Service.Running
Service.Name
Service.TimeLocation
Service.LocalizedTime
Service.Configure(IConfigSectionNode)
Service.Start()
Service.SignalStop()
Service.CheckForCompleteStop()
Service.WaitForCompleteStop()
Service.AcceptManagerVisit(Object, DateTime)
Service.UniversalTimeToLocalizedTime(DateTime)
Service.LocalizedTimeToUniversalTime(DateTime)
Service.AbortStart()
Service.DoStart()
Service.DoSignalStop()
Service.DoCheckForCompleteStop()
Service.DoWaitForCompleteStop()
Service.DoConfigure(IConfigSectionNode)
Service.CheckServiceInactive()
Service.CheckServiceActive()
Service.CheckServiceActiveOrStarting()
Service.DoAcceptManagerVisit(Object, DateTime)
Service.____ObtainPrivateServiceStatusLockObject()
ApplicationComponent.AllComponents
ApplicationComponent.GetAppComponentBySID(UInt64)
ApplicationComponent.GetAppComponentByCommonName(String)
ApplicationComponent.ComponentSID
ApplicationComponent.ComponentStartTime
ApplicationComponent.ComponentCommonName
DisposableObject.DisposeAndNull<T>(T)
DisposableObject.DisposeStarted
DisposableObject.Disposed
DisposableObject.EnsureObjectNotDisposed()
DisposableObject.Dispose()
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

IApplicationComponent
System.IDisposable
IService
INamed
ILocalizedTimeProvider
IInstrumentable
IExternallyParameterized
IMessageSink
IConfigurable

Extension Methods

MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX