Class TransientFaultExceptionConverter

Namespace

Cuemon.Extensions.Text.Json.Converters

Assembly

Cuemon.Extensions.Text.Json.dll

Converts a TransientFaultException to or from JSON.

public class TransientFaultExceptionConverter : JsonConverter<TransientFaultException>

Inheritance

object

JsonConverter

JsonConverter<TransientFaultException>

TransientFaultExceptionConverter

Inherited Members

JsonConverter<TransientFaultException>.CanConvert(Type)

JsonConverter<TransientFaultException>.ReadAsPropertyName(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<TransientFaultException>.WriteAsPropertyName(Utf8JsonWriter, TransientFaultException, JsonSerializerOptions)

JsonConverter<TransientFaultException>.HandleNull

JsonConverter<TransientFaultException>.Type

Extension Methods

EnumerableExtensions.Yield<T>(T)

ObjectExtensions.Adjust<T>(T, Func<T, T>)

ObjectExtensions.Alter<T>(T, Action<T>)

ObjectExtensions.As<T, TResult>(T, Func<T, TResult>)

ObjectExtensions.IsNullable<T>(T)

ObjectExtensions.UseWrapper<T>(T, Action<IDictionary<string, object>>)

ObjectExtensions.UseWrapper<T>(T, MemberInfo, Action<IDictionary<string, object>>)

ObjectExtensions.As(object, Type, Action<ObjectFormattingOptions>)

ObjectExtensions.As<T>(object, T, Action<ObjectFormattingOptions>)

Examples

TransientFaultExceptionConverter serializes and deserializes TransientFaultException instances including their TransientFaultEvidence with attempt count, recovery wait times, latency, and method signature. This example creates a TransientFaultException with evidence (Attempts = 3, RecoveryWaitTime = 2s, etc.) and a method descriptor, then configures a JsonFormatter with the converter and serializes it to JSON. The deserialization part reads the JSON back through the same formatter, reconstructing the exception with its Evidence properties intact. Console output displays the round-tripped message ("Failed to connect after 3 retries.") and evidence attempt count (3).

using System;
using System.IO;
using System.Text;
using Cuemon.Extensions.Text.Json.Converters;
using Cuemon.Extensions.Text.Json;
using Cuemon.Extensions.Text.Json.Formatters;
using Cuemon.Reflection;
using Cuemon.Resilience;

namespace MyApp.Examples;

public class TransientFaultExceptionConverterExample
{
    public void SerializeTransientFaultException()
    {
        // Create a transient fault exception with evidence
        var evidence = new TransientFaultEvidence(
            attempts: 3,
            recoveryWaitTime: TimeSpan.FromSeconds(2),
            totalRecoveryWaitTime: TimeSpan.FromSeconds(6),
            latency: TimeSpan.FromMilliseconds(500),
            descriptor: new MethodSignature(
                "MyService",
                "ConnectAsync",
                new[] { "connectionString" },
                new object[] { "server=db;timeout=30" }));

        var exception = new TransientFaultException(
            "Failed to connect after 3 retries.",
            new TimeoutException("Connection timed out."),
            evidence);

        // Configure JSON formatter with the converter
        var options = new JsonFormatterOptions();
        options.Settings.Converters.Add(new TransientFaultExceptionConverter());

        // Serialize to JSON
        var formatter = new JsonFormatter(options);
        using (var stream = formatter.Serialize(exception))
        using (var reader = new StreamReader(stream))
        {
            string json = reader.ReadToEnd();
            Console.WriteLine(json);
            // The output includes exception details, inner exception, and evidence:
            // {
            //   "type": "Cuemon.Resilience.TransientFaultException",
            //   "message": "Failed to connect after 3 retries.",
            //   "evidence": {
            //     "attempts": 3,
            //     ...
            //   }
            // }
        }
    }

    public void DeserializeTransientFaultException()
    {
        string json = @"{
  ""type"": ""Cuemon.Resilience.TransientFaultException"",
  ""message"": ""Failed to connect after 3 retries."",
  ""evidence"": {
    ""attempts"": 3,
    ""recoveryWaitTime"": ""00:00:02"",
    ""totalRecoveryWaitTime"": ""00:00:06"",
    ""latency"": ""00:00:00.500"",
    ""descriptor"": {
      ""caller"": ""MyService"",
      ""methodName"": ""ConnectAsync"",
      ""parameters"": [""connectionString""],
      ""arguments"": [""server=db;timeout=30""]
}";

        var options = new JsonFormatterOptions();
        options.Settings.Converters.Add(new TransientFaultExceptionConverter());

        using (var stream = new MemoryStream(Encoding.UTF8.GetBytes(json)))
        {
            var formatter = new JsonFormatter(options);
            var exception = formatter.Deserialize<TransientFaultException>(stream);

            Console.WriteLine(exception.Message);
            Console.WriteLine($"Evidence - Attempts: {exception.Evidence.Attempts}");
        }
    }
}

Methods

Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

Reads and converts the JSON to type TransientFaultException.

public override TransientFaultException Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Parameters

reader Utf8JsonReader

The Utf8JsonReader to read from.

typeToConvert Type

The Type being converted.

options JsonSerializerOptions

The JsonSerializerOptions being used.

Returns

TransientFaultException

The value that was converted.

Write(Utf8JsonWriter, TransientFaultException, JsonSerializerOptions)

Writes the value as JSON.

public override void Write(Utf8JsonWriter writer, TransientFaultException value, JsonSerializerOptions options)

Parameters

writer Utf8JsonWriter

The Utf8JsonWriter to write to.

value TransientFaultException

The value to convert.

options JsonSerializerOptions

The JsonSerializerOptions being used.

See Also

JsonConverter<T>