RelayError Class

Contains a symbolic relay error code, diagnostic message, and optional structured details.

public sealed record RelayError : Meshline.Models.Protocol.ProtocolModel, System.IEquatable<Meshline.Models.Protocol.RelayError>

Inheritance System.Object → ProtocolModel → RelayError

RelayError.Code Property

The symbolic protocol error code, such as rate_limited.

public string Code { get; init; }

Optional structured error details, with JSON values cloned on assignment.

public System.Collections.Immutable.ImmutableDictionary<string,System.Text.Json.JsonElement>? Data { get; init; }

The relay's human-readable error description.

public string Message { get; init; }

Reads a nonnegative retry delay from a rate-limit error, in seconds.

public System.Nullable<long> GetRetryAfter();

System.Nullable<System.Int64 >
The retry delay in seconds, or null when no applicable hint is present.

System.Text.Json.JsonException
The applicable retry hint is not a nonnegative integer.

Maps the symbolic relay error code to its JSON-RPC numeric code when known.

public System.Nullable<long> GetRpcErrorCode();

System.Nullable<System.Int64 >
The known JSON-RPC error number, or null for an unknown symbolic code.

Determines whether the relay error proves that the submitted operation was rejected.

public bool IsDefinitiveRejection();

System.Boolean
true if the error is a known definitive rejection; otherwise, false.