• Avalanche.Core
Search Results for

    Show / Hide Table of Contents
    • Avalanche.Accessor
      • Introduction
      • IAccessor
        • IAccessor
        • IFieldAccessor
        • IListAccessor
        • IMapAccessor
        • IRecordAccessor
        • IOneOfAccessor
        • IAnyAccessor
      • Dto
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Articles
        • Dependency Injection
        • AccessorMessages
    • Avalanche.Binding
      • Introduction
    • Avalanche.Configuration
      • Introduction
      • Configuration Binding
      • ConfigurationExtensions
      • MemoryConfiguration
      • PrintTree
      • Saving IOptions
      • Yaml
    • Avalanche.Converter
      • Introduction
      • EnumConverter
      • Func<,>
      • HexConverter
      • PrimitiveConverter
      • StringConverter
    • Avalanche.Core
      • License
    • Avalanche.DataType
      • Introduction
      • DataType
        • IDataType
        • IListType
        • IMapType
        • IRecordType
        • IFieldType
        • IOneOfType
        • IAnyType
        • IStringType
        • IValueType
        • IIntegerType
        • IEnumerationType
        • IFloatingPointType
      • Dto
        • DtoTarget
        • Class
        • Enum
        • FieldInfo
        • IList<T>
        • IDictionary<K,V>
        • OneOfAttribute
        • StructLayoutAttribute
        • IntermediateTarget
      • Articles
        • DataTypeRequest
        • PrintTree
        • DataTypeMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
        • CustomAttributeUtilities
        • ToStringRequest
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystemBrowse
        • IFileSystemCreateDirectory
        • IFileSystemDelete
        • IFileSystemFileAttribute
        • IFileSystemMount
        • IFileSystemMove
        • IFileSystemObserve
        • IFileSystemOpenStream
        • IFileSystemOpenMemory
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Utilities
        • Dispose
        • FileDictionary
        • FileScanner
        • FilterEnumerable
        • OperationSession
        • PollingFilterWatchToken
        • VisitTree
      • Article
        • Examples
        • PrintTree
    • Avalanche.Identity
      • Introduction
      • Identity
      • IdentityParts
      • IdentityInterner
      • IdentityComparer
      • Print Tree
      • IdentityAccessors
        • Introduction
        • TypeName
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
      • Asp.Net
        • Introduction
        • Supplying localization
        • Inject to pages
        • Culture Assigned
        • Minimalistic Api
        • Diagnostics
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR40
        • Unicode.CLDR41
        • Unicode.CLDR42
        • Unicode.CLDR43
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
        • Printing templates
    • Avalanche.Memory
      • Introduction
      • IMemory<T>
      • BlockMemory<T>
      • FileMemory
      • ListMemory<L, T>
      • MemoryMemory<T>
      • MMFMemory<T>
      • PointerMemory<T>
      • Slice<M, T>
      • StreamMemory
      • Concurrency
        • RWLockedMemory
        • SynchronizedMemory
      • Serialization
        • Benchmarks
        • FixedSize<T>
        • FixedSizeZigZag<T>
        • VariableSized<T>
        • VariableSizedZigZag<T>
        • StringEncoding
      • Articles
        • Fixed-size and Variable-sized
        • IBlockPool<T>
        • Print Tree
        • Read and Write events
        • Stream View
        • Zero Heap
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageDescriptionsBase
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Microsoft.Extensions
        • DependencyInjection
      • Articles
        • Aggregate Messages
        • Localization
        • Localization Templates
        • Logging
        • Validation
    • Avalanche.Module
      • Introduction
      • IServiceCollection
      • IServiceBuilder
      • IHostBuilder
      • Dependencies
    • Avalanche.Options
      • Introduction
      • OptionsExtensions
      • OptionsMonitorCast
    • Avalanche.Protobuf
      • Introduction
    • Avalanche.Service
      • Introduction
      • Service
        • Introduction
        • IService
        • IServiceDisposable
        • IServiceDecoration
        • IServiceCast
        • IServiceObservable
        • IServiceContainer
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Scope
      • Handler
        • Introduction
        • IHandler
        • IHandlerCast
        • IHandlerDecoration
        • IHandlerWithOrder
        • CancellationToken
        • Cyclicity
        • Delegates
        • Invokable
        • ExportAttribute
        • OrderAttribute
        • PrintTree
        • Recursion
      • Query
        • Introduction
        • IQuery
        • IQueryCast
        • IQueryDecoration
      • Entry
        • Introduction
        • IEntry
        • IEntryCast
        • IEntryDecoration
        • IEntryObservable
        • IEntryVisitable
        • EntryState
      • Request
        • Introduction
        • IRequest
        • IRequestFor
        • IRequestToBeCached
        • IRequestToBeDisposed
        • RequestAttribute
        • ContextParameterAttribute
        • Print Tree
      • Dependency Injection
        • Introduction
        • Asp.Net
        • ServiceRequest<T>
        • Decorating a service
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
        • IHostBuilder
      • Examples
        • NodeCount
        • Expression
        • Mapper
      • Articles
        • Benchmarks
        • Error Handling
        • ServiceMessages
    • Avalanche.StatusCode
      • Introduction
      • HResult
        • Introduction
        • HResult.Facilities
        • BasicMessages
        • RpcMessages
        • DispatchMessages
        • StorageMessages
        • ItfMessages
        • Win32Messages
        • WindowsMessages
        • SspiMessages
        • CertMessages
        • MediaServerMessages
        • SetupApiMessages
        • ScardMessages
        • ComPlusMessages
        • ClrMessages
        • UserModeFilterManagerMessages
        • GraphicsMessages
        • TpmServicesMessages
        • TpmSoftwareMessages
        • PlaMessages
        • FveMessages
        • FwpMessages
        • NdisMessages
        • DltMessages
      • System
        • Introduction
        • AccessControlMessages
        • AggregateMessages
        • AppDomainMessages
        • ArgumentMessages
        • ArgumentNullMessages
        • ArgumentOutOfRangeMessages
        • ArithmeticMessages
        • ArrayMessages
        • AssemblyMessages
        • BadImageFormatMessages
        • CodeContractMessages
        • CodePageMessages
        • CollectionsMessages
        • CompilerServiceMessages
        • CryptographyMessages
        • CultureMessages
        • DiagnosticsMessages
        • EventSourceMessages
        • ExecutionEngineMessages
        • FormatMessages
        • HostProtectionMessages
        • IOMessages
        • IndexOutOfRangeMessages
        • InteropServiceMessages
        • InvalidCastMessages
        • InvalidOperationMessages
        • IsolatedStorageMessages
        • LazyMessages
        • MarshalerMessages
        • MemoryMessages
        • MiscellaneousMessages
        • NotImplementedMessages
        • NotSupportedMessages
        • ObjectDisposedMessages
        • OperationCanceledMessages
        • OverflowMessages
        • PlatformMessages
        • PolicyMessages
        • PrincipalMessages
        • ProgramMessages
        • ReferenceMessages
        • ReflectionMessages
        • RegionMessages
        • RemotingMessages
        • ResourcesMessages
        • SecurityMessages
        • SerializationMessages
        • StackMessages
        • TaskMessages
        • TextMessages
        • ThreadingMessages
        • TimeZoneMessages
        • TypeMessages
        • XmlMessages
      • HttpStatusCode
      • OpcUaStatusCode
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Utilities
      • Introduction
      • Collections
        • ArrayList
        • ArrayUtilities
        • BijectionMap
        • CachedSelect
        • DictionaryAdapter
        • EnumerableExtensions
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • StructList
        • Tuples
        • TupleUtilities
      • Comparers
        • IGraphComparer
        • IGraphComparable
        • AlphaNumericComparer
        • EnumerableComparer
        • EnumerableGraphComparer
        • ReferenceComparer
        • KeyValuePairComparer
        • DefaultComparerProvider
        • RecordComparer
      • Cloners
        • ICloner
        • IGraphCloner
        • IGraphCloneable
        • ListCloner
        • DictionaryCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Pipe
        • Cache
        • ResultCapture
        • AsReadOnly
        • SharedResource
        • AsService
        • IProviderEvent
      • Record
        • IRecordDescription
        • IFieldDescription
        • IConstructorDescription
        • IConstructionDescription
        • IParameterDescription
        • IRecordProviders
        • RecordDelegates
          • RecordCreate
          • RecordClone
          • RecordCopy
          • IRecordDelegates
        • FieldDelegates
          • FieldRead
          • FieldWrite
          • RecreateWith
          • IFieldDelegates
      • Reflection
        • EnumDescription
      • String
        • IEscaper
        • UnicodeString
        • Hex
      • Miscellaneous
        • IIdGenerator
        • Permutation
        • IReadOnly
        • IUserDataContainer
        • ITreeNode
        • Void
    • Avalanche.Writer
      • Introduction
      • ConstantWriter
      • Context
      • ConvertWriter
      • DefaultConstructor
      • DelegateWriter
      • PassthroughWriter
      • Referer
      • TypeCast
      • Writer
      • WriterPipe
      • WriterMessages

    IMessage

    IMessage describes message with arguments, code, id, time and error fields.

    /// <summary>Message entry with arguments.</summary>
    /// <remarks>
    /// Message <see cref="IDictionary"/> implementation provides parameter name to argument mapping.
    /// Message <see cref="object.ToString"/> prints <see cref="Arguments"/> in <see cref="IMessageDescription.Template"/> using 'null' culture.
    /// </remarks>
    public interface IMessage : IDictionary, IDictionary<string, object?>, IUserDataContainer, IFormattable, ISpanFormattable
    {
        /// <summary>Message identification, such as <see cref="int"/> or <see cref="Guid"/></summary>
        object? Id { get; set; }
        /// <summary>Message description.</summary>
        IMessageDescription MessageDescription { get; set; }
        /// <summary>Arguments.</summary>
        object?[] Arguments { get; set; }
        /// <summary>Event occurance time.</summary>
        DateTime? Time { get; set; }
        /// <summary>Message severity level for logging.</summary>
        MessageLevel? Severity { get; set; }
        /// <summary>Captured error</summary>
        Exception? Error { get; set; }
        /// <summary>Inner messages</summary>
        IMessage[]? InnerMessages { get; set; }
    }
    

    Message is the default implementation.

    IMessage message = new Message(
        messageDescription: CoreMessages.Instance.GoodValid,
        arguments: obj
    );
    

    IMessage can be constructed with IMessageDescription.New(arguments) extension method.

    IMessage goodStatus = CoreMessages.Instance.GoodValid.New(obj);
    IMessage errorStatus = CoreMessages.Instance.BadNotValid.New(obj, "Unexpected");
    IMessage errorStatusNullArg = CoreMessages.Instance.BadNullArgument.New(obj, "Name");
    

    ValueMessage is value-typed implementation. It can be used as zero heap message type for example in rapid eventing.

    ValueMessage message = new ValueMessage(
        messageDescription: CoreMessages.Instance.GoodValid,
        arguments: new object()
    );
    

    IMessageDescription.NameOf(expression) constructs message from expression text. See mscorlib.dll scraped Argument, ArgumentNull and ArgumentOutOfRange validation messages.

    object argument = null!;
    IMessage msg = SystemMessages.ArgumentNull.WithParamName.NameOf(argument);
    WriteLine(msg); // Parameter 'argument' cannot be null.
    

    .SetId(object) assigns message event id. IIdGenerator generates unique identities.

    object obj = new object();
    IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetId(IdGenerators.Guid.Next);
    WriteLine(msg.Id); // "679b2f1a-3341-4cc6-81d6-5c55bbdde164"
    

    .SetTime(time) assigns event occurance time.

    object obj = new object();
    IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetTime(DateTime.Now);
    WriteLine(msg.Time); // 
    

    .SetNow() assigns event occurance time as now.

    object obj = new object();
    IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetNow();
    WriteLine(msg.Time); // 
    

    .UserData stores user data. Dictionary is lazy constructed and safe for concurrent use. See IUserDataContainer.

    // Create message
    IMessage msg = CoreMessages.Instance.BadReadOnly.New();
    // Set data
    msg.UserData["Hello"] = "World";
    // Read data
    WriteLine(msg.UserData["Hello"]); // "World"
    

    .SetUserData(key, value) assigns value to user data.

    // Create message
    IMessage msg = CoreMessages.Instance
        .BadReadOnly
        .New()
        .SetUserData("Hello", "World");
    // Read data
    WriteLine(msg.UserData["Hello"]); // "World"
    

    IDictionary implementation reflects parameter to argument mapping.

    // Create message without argument
    IMessage msg = CoreMessages.Instance.BadUnexpected.New();
    // Cast to dictionary
    IDictionary<string, object?> args = msg;
    // Assign argument to parameter
    args["object"] = "MyObject";
    // Print "'MyObject': Could not change object in read-only state."
    WriteLine(msg);
    

    .InnerMessage holds an inner message.

    // Create inner message
    IMessage msg1 = CoreMessages.Instance.BadReadOnly.New();
    // Create outer message
    IMessage msg2 = CoreMessages.Instance.BadUnexpected.New().SetInnerMessage(msg1);
    

    Message.SetInterpolated(string) assigns message description and arguments from an interpolated string.

    // Create arguments
    string user = "User";
    DateTime time = DateTime.Now;
    long errorCode = 0x80000000;
    // Create message
    IMessage message = new Message().SetInterpolated($"Hello {user}, time is {time}, error is [0x{errorCode:X8}].");
    // Print text
    WriteLine(message); // "Hello User, time is 10.1.2022 23.22.55, error is [0x80000000]."
    // Print template text
    WriteLine(message.MessageDescription.Template); // "Hello {0}, time is {1}, error is [0x{2:X8}]."
    // Print argument
    WriteLine(message.Arguments[0]); // "User"
    
    // Reconstruct template
    string assembly = TemplateFormat.Percent.Assemble[message.MessageDescription.Template.Breakdown];
    // Print assembly
    WriteLine(assembly); // "Hello %1, time is %2, error is [0x%3]."
    

    Message is assignable to interpolated string parameters due to FormattableString implementation.

    // Create template
    ITemplateText text = TemplateFormat.Percent.Text["Hello %1, time is %2."];
    // Create message description
    IMessageDescription messageDescription = new MessageDescription().SetTemplate(text);
    // Create message
    Message message = messageDescription.New("User", DateTime.Now);
    // Cast to FormattableString
    FormattableString formattableString = message;
    // Use like string interpolation
    WriteLine(FormattableString.Invariant(formattableString)); // "Hello User, time is 01/10/2022 21:56:49."
    

    Full Example

    Full example
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using Avalanche.Utilities;
    using Avalanche.Message;
    using static System.Console;
    using Avalanche.StatusCode;
    using System.Globalization;
    using Avalanche.Template;
    
    class message_index
    {
        public static void Run()
        {
            {
                object obj = new object();
                // <01>
                IMessage message = new Message(
                    messageDescription: CoreMessages.Instance.GoodValid,
                    arguments: obj
                );
                // </01>
                // <02>
                IMessage goodStatus = CoreMessages.Instance.GoodValid.New(obj);
                IMessage errorStatus = CoreMessages.Instance.BadNotValid.New(obj, "Unexpected");
                IMessage errorStatusNullArg = CoreMessages.Instance.BadNullArgument.New(obj, "Name");
                // </02>
            }
            { 
                // <03>
                ValueMessage message = new ValueMessage(
                    messageDescription: CoreMessages.Instance.GoodValid,
                    arguments: new object()
                );
                // </03>
            }
            {
                // <04>
                object argument = null!;
                IMessage msg = SystemMessages.ArgumentNull.WithParamName.NameOf(argument);
                WriteLine(msg); // Parameter 'argument' cannot be null.
                // </04>
            }
            {
                // <05>
                object obj = new object();
                IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetId(IdGenerators.Guid.Next);
                WriteLine(msg.Id); // "679b2f1a-3341-4cc6-81d6-5c55bbdde164"
                // </05>
            }
    
            {
                // <06>
                object obj = new object();
                IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetTime(DateTime.Now);
                WriteLine(msg.Time); // 
                // </06>
            }
    
            {
                // <07>
                object obj = new object();
                IMessage msg = CoreMessages.Instance.BadNotValid.New(obj, "Unknown").SetNow();
                WriteLine(msg.Time); // 
                // </07>
            }
    
    
            {
                // <08>
                // Create message
                IMessage msg = CoreMessages.Instance.BadReadOnly.New();
                // Set data
                msg.UserData["Hello"] = "World";
                // Read data
                WriteLine(msg.UserData["Hello"]); // "World"
                // </08>
            }
    
            {
                // <09>
                // Create message
                IMessage msg = CoreMessages.Instance
                    .BadReadOnly
                    .New()
                    .SetUserData("Hello", "World");
                // Read data
                WriteLine(msg.UserData["Hello"]); // "World"
                // </09>
            }
    
            {
                // <11>
                // Create message without argument
                IMessage msg = CoreMessages.Instance.BadUnexpected.New();
                // Cast to dictionary
                IDictionary<string, object?> args = msg;
                // Assign argument to parameter
                args["object"] = "MyObject";
                // Print "'MyObject': Could not change object in read-only state."
                WriteLine(msg);
                // </11>
            }
    
            {
                // <13>
                // Create inner message
                IMessage msg1 = CoreMessages.Instance.BadReadOnly.New();
                // Create outer message
                IMessage msg2 = CoreMessages.Instance.BadUnexpected.New().SetInnerMessage(msg1);
                // </13>
            }
    
            {
                // <40>
                // Create arguments
                string user = "User";
                DateTime time = DateTime.Now;
                long errorCode = 0x80000000;
                // Create message
                IMessage message = new Message().SetInterpolated($"Hello {user}, time is {time}, error is [0x{errorCode:X8}].");
                // Print text
                WriteLine(message); // "Hello User, time is 10.1.2022 23.22.55, error is [0x80000000]."
                // Print template text
                WriteLine(message.MessageDescription.Template); // "Hello {0}, time is {1}, error is [0x{2:X8}]."
                // Print argument
                WriteLine(message.Arguments[0]); // "User"
    
                // Reconstruct template
                string assembly = TemplateFormat.Percent.Assemble[message.MessageDescription.Template.Breakdown];
                // Print assembly
                WriteLine(assembly); // "Hello %1, time is %2, error is [0x%3]."
                // </40>
            }
            {
                // <41>
                // Create template
                ITemplateText text = TemplateFormat.Percent.Text["Hello %1, time is %2."];
                // Create message description
                IMessageDescription messageDescription = new MessageDescription().SetTemplate(text);
                // Create message
                Message message = messageDescription.New("User", DateTime.Now);
                // Cast to FormattableString
                FormattableString formattableString = message;
                // Use like string interpolation
                WriteLine(FormattableString.Invariant(formattableString)); // "Hello User, time is 01/10/2022 21:56:49."
                // </41>
            }
        }
    }
    
    In This Article
    Back to top