IRequest

IRequest is an optional indication that Type is a service request.

/// <summary>
/// Indicates that Type is a service request. 
/// 
/// Request implementations must be immutable or used as such.
/// 
/// See sub-interfaces:
///     <see cref="IRequestForType"/>
///     <see cref="IRequestFor{Value}"/>
///     <see cref="IRequestInvocation"/>
///     <see cref="IRequestToBeCached"/>
///     <see cref="IRequestNotToBeCached"/>
/// </summary>
public interface IRequest { }

IRequest
├── IRequestForType
├── IRequestForT
│   └── IRequestFor<Response>
│       └── IRequestForInvocation
│
├── IRequestToBeDisposed
├── IRequestNotToBeDisposed
├── IRequestToBeCached
└── IRequestNotToBeCached

IRequestFor<T>

IRequestFor<T> indicates result type of the request.

/// <summary>
/// Indicates that there is a specific result type.
/// 
/// The implementing class implements either <see cref="IRequestForType"/> or <see cref="IRequestFor{ResultType}"/>.
/// </summary>
public interface IRequestFor : IRequest { }

/// <summary>Indicates that there is a specific result type.</summary>
public interface IRequestForType : IRequestFor
{
    /// <summary>Get Result Type, if available</summary>
    Type? ResultType { get; }
}

/// <summary>
/// Indicates that there is a specific result type in subinterface <see cref="IRequestFor{ResultType}"/>.
/// 
/// This implementing class implements <see cref="IRequestFor{ResultType}"/>.
/// </summary>
public interface IRequestForT : IRequestFor { }

/// <summary>Indicates expected result type.</summary>
/// <typeparam name="ResultType"></typeparam>
public interface IRequestFor<out ResultType> : IRequest, IRequestForT { }

/// <summary>Request to invocate action. </summary>
public interface IRequestInvocation : IRequestFor<Avalanche.Void> { }

Request class inherites IRequestFor<T> to indicate result type.

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestFor<string>;

Another way to indicate with property IRequestForType.ResultType.

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestForType
{
    Type? IRequestForType.ResultType => typeof(string);
}

IRequestToBeCached

IRequestToBeCached indicates that request is to be cached.

/// <summary>Indicates that the request is to be cached. Requires <see cref="CachePolicies.Default"/>, <see cref="CachePolicies.DefaultYes"/> or <see cref="CachePolicies.UseInterface"/>.</summary>
public interface IRequestToBeCached : IRequest { }

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestToBeCached;

IRequestNotToBeCached indicates that request is not to be cached.

/// <summary>Indicates that the request is not to be cached. Requires <see cref="CachePolicies.Default"/>, <see cref="CachePolicies.DefaultYes"/> or <see cref="CachePolicies.UseInterface"/>.</summary>
public interface IRequestNotToBeCached : IRequest { }

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestNotToBeCached;

IRequestToBeDisposed

IRequestToBeDisposed indicates that the result object from this request is to be disposed along service or its cache. Note that, this is however default behaviour with default entry policy, even without the interface.

/// <summary>Indicates that if the result of this request is cached and is disposable, then it is to be disposed. Requires <see cref="EntryPolicies.Default"/> or <see cref="EntryPolicies.UseInterface"/> entry policy.</summary>
public interface IRequestToBeDisposed : IRequest { }

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestToBeDisposed;

IRequestNotToBeDisposed indicates that the result object from this request is not to be disposed. This overrides the default behaviour.

/// <summary>Indicates that the result of this request is not to be disposed. Requires <see cref="EntryPolicies.Default"/> or <see cref="EntryPolicies.UseInterface"/>.</summary>
public interface IRequestNotToBeDisposed : IRequest { }

/// <summary>Request to print record-like object as json-string</summary>
public record PrintAsJson(Object record) : IRequestNotToBeDisposed;

IRequestNotToBeDisposed and IRequestToBeDisposed require that EntryPolicies.Default or EntryPolicies.UseInterface are used, and they are applied with default settings.

Full Example

Full example

using System;
using Avalanche.Service;

public class request_irequest
{
    public static void Run()
    {
        {
            // <01>
            // </01>
        }
    }

    static class _11
    {
        // <11>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestFor<string>;
        // </11>
    }
    static class _12
    {
        // <12>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestForType
        {
            Type? IRequestForType.ResultType => typeof(string);
        }
        // </12>
    }

    static class _21
    {
        // <21>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestToBeCached;
        // </21>
    }

    static class _22
    {
        // <22>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestNotToBeCached;
        // </22>
    }

    static class _31
    {
        // <31>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestToBeDisposed;
        // </31>
    }

    static class _32
    {
        // <32>
        /// <summary>Request to print record-like object as json-string</summary>
        public record PrintAsJson(Object record) : IRequestNotToBeDisposed;
        // </32>
    }



}