• Avalanche.Core
Search Results for

    Show / Hide Table of Contents
    • Avalanche.Accessor
      • Introduction
      • IAccessor
        • IAccessor
        • IListAccessor
        • IMapAccessor
        • IRecordAccessor
        • IContentAccessor
        • IOneOfAccessor
        • IAnyAccessor
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • 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
        • IRealType
      • .Net
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • Enum
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Protobuf
        • Introduction
      • Articles
        • DataTypeRequest
        • PrintTree
        • DataTypeMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystem
          • IFileSystemBrowse
          • IFileSystemCreateDirectory
          • IFileSystemDelete
          • IFileSystemFileAttribute
          • IFileSystemMount
          • IFileSystemMove
          • IFileSystemObserve
          • IFileSystemOpen
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Events
      • Utilities
        • Dispose
        • File Scanner
        • Visit Tree
        • File Operation
        • FilterEnumerable
        • PollingFilterWatchToken
    • 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
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
        • Printing templates
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Microsoft.Extensions
        • DependencyInjection
      • Articles
        • Aggregate Messages
        • Localization
        • Logging
        • Validation
    • Avalanche.Options
      • Introduction
      • OptionsExtensions
      • OptionsMonitorCast
    • 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
        • Tuples
        • StructList
        • ArrayList
        • BijectionMap
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • EnumerableExtensions
        • TupleUtilities
        • ArrayUtilities
      • 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
        • 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

    RequestAttribute

    [Request] attribute indicates that if a field contains a value that implements IRequest or IRecord, it will be resolved before processing the query further.

    public record Sum([Request] object a, [Request] object b) : IRequestFor<int>;
    

    [RequestArray] indicates that if a field contains a value that implements IEnumerable of IRequest or IRecord, it will be resolved before processing the query further.

    public record Sum([RequestArray] object values) : IRequestFor<int>;
    

    Using both attributes together indicates that field may contain a request for an array whose elements are to be resolved.

    public record Sum([Request, RequestArray] object values) : IRequestFor<int>;
    

    Service must have ServiceHandlers or its subcomponent RequestHandlers for resolve to work.

    IService service = Services.Create((new StringJoinHandler(), RequestHandlers.Instance, RequestResolverAsync.Instance));
    
    IService service = Services.Create((new StringJoinHandler(), ServiceHandlers.Instance));
    

    In the following example, a handler concatenates strings with separator. Field-requests are resolved before handler is invoked.

    // Create service
    IService service = Services.Create((RequestHandlers.Instance, new StringJoinHandler()));
    // Create request
    IRequestFor<string> joinRequest = new StringJoinRequest(", ", "Hello", new StringJoinRequest("+", "World", "Sphere"));
    // Print request
    WriteLine(joinRequest.PrintTree());
    // StringJoinRequest
    // ├── Separator = ", "
    // ├── Strings[0] = "Hello"
    // └── Strings[1] = StringJoinRequest
    //     ├── Separator = "+"
    //     ├── Strings[0] = "World"
    //     └── Strings[1] = "Sphere"
    // Execute request
    string joinText = service.GetRequired<IRequestFor<string>, string>(joinRequest);
    // Print join
    Console.WriteLine(joinText); // "Hello, World+Sphere"
    
    /// <summary>Join strings with <see cref="String.Join"/></summary>
    public record StringJoinRequest : IRequestFor<string>
    {
        /// <summary>Separator string, <see cref="String"/>, <![CDATA[IRequestFor<string>]]></summary>
        [Request]
        public object Separator { get; init; }
    
        /// <summary>Strings to join as array</summary>
        [Request, RequestArray]
        public object Strings { get; init; }
    
        /// <summary>Create request</summary>
        public StringJoinRequest(object separator, params object[] strings)
        {
            Separator = separator;
            Strings = strings;
        }
    }
    
    /// <summary>Join strings</summary>
    public class StringJoinHandler : IHandler<StringJoinRequest, string>
    {
        /// <summary>Join strings</summary>
        public void Handle(IQuery<StringJoinRequest, string> query)
        {
            // Handled
            if (query.Handled()) return;
            // Get separator
            if (query.Request.Separator is not string separator) return;
            // Get strings
            if (query.Request.Strings is not Array strings) return;
            // Create builder
            StringBuilder sb = new StringBuilder();
            // 
            for (int i = 0; i < strings.Length; i++)
            {
                // Append separator
                if (i > 0) sb.Append(separator);
                // Get value
                string? value = strings.GetValue(i)?.ToString();
                // Append string
                if (value != null) sb.Append(value);
            }
            // Build text
            string text = sb.ToString();
            // Assign result
            query.Response.SetValue(text);
        }
    }
    

    Full Example

    Full example
    using System;
    using System.Text;
    using Avalanche.Service;
    using Avalanche.Utilities.Record;
    using static System.Console;
    
    public class request_requestattribute
    {
        public static void Run()
        {
            {
                // <01>
                IService service = Services.Create((new StringJoinHandler(), RequestHandlers.Instance, RequestResolverAsync.Instance));
                // </01>
            }
            {
                // <02>
                IService service = Services.Create((new StringJoinHandler(), ServiceHandlers.Instance));
                // </02>
            }
            {
                // <03>
                // Create service
                IService service = Services.Create((RequestHandlers.Instance, new StringJoinHandler()));
                // Create request
                IRequestFor<string> joinRequest = new StringJoinRequest(", ", "Hello", new StringJoinRequest("+", "World", "Sphere"));
                // Print request
                WriteLine(joinRequest.PrintTree());
                // StringJoinRequest
                // ├── Separator = ", "
                // ├── Strings[0] = "Hello"
                // └── Strings[1] = StringJoinRequest
                //     ├── Separator = "+"
                //     ├── Strings[0] = "World"
                //     └── Strings[1] = "Sphere"
                // Execute request
                string joinText = service.GetRequired<IRequestFor<string>, string>(joinRequest);
                // Print join
                Console.WriteLine(joinText); // "Hello, World+Sphere"
                // </03>
            }
        }
    
        static class _10
        {
            // <10>
            public record Sum([Request] object a, [Request] object b) : IRequestFor<int>;
            // </10>
        }
        static class _11
        {
            // <11>
            public record Sum([RequestArray] object values) : IRequestFor<int>;
            // </11>
        }
        static class _12
        {
            // <12>
            public record Sum([Request, RequestArray] object values) : IRequestFor<int>;
            // </12>
        }
    
        // <13>
        /// <summary>Join strings with <see cref="String.Join"/></summary>
        public record StringJoinRequest : IRequestFor<string>
        {
            /// <summary>Separator string, <see cref="String"/>, <![CDATA[IRequestFor<string>]]></summary>
            [Request]
            public object Separator { get; init; }
    
            /// <summary>Strings to join as array</summary>
            [Request, RequestArray]
            public object Strings { get; init; }
    
            /// <summary>Create request</summary>
            public StringJoinRequest(object separator, params object[] strings)
            {
                Separator = separator;
                Strings = strings;
            }
        }
        // </13>
    
        // <14>
        /// <summary>Join strings</summary>
        public class StringJoinHandler : IHandler<StringJoinRequest, string>
        {
            /// <summary>Join strings</summary>
            public void Handle(IQuery<StringJoinRequest, string> query)
            {
                // Handled
                if (query.Handled()) return;
                // Get separator
                if (query.Request.Separator is not string separator) return;
                // Get strings
                if (query.Request.Strings is not Array strings) return;
                // Create builder
                StringBuilder sb = new StringBuilder();
                // 
                for (int i = 0; i < strings.Length; i++)
                {
                    // Append separator
                    if (i > 0) sb.Append(separator);
                    // Get value
                    string? value = strings.GetValue(i)?.ToString();
                    // Append string
                    if (value != null) sb.Append(value);
                }
                // Build text
                string text = sb.ToString();
                // Assign result
                query.Response.SetValue(text);
            }
        }
        // </14>
    }
    
    In This Article
    Back to top Copyright © Toni Kalajainen