EveClientOptions

NexusLabs.Eve

EveClientOptions Class

Configures an EveClient for one eve deployment.

public sealed record EveClientOptions : System.IEquatable<NexusLabs.Eve.EveClientOptions>

Inheritance System.Object → EveClientOptions

Implements System.IEquatable<EveClientOptions>

Constructors

EveClientOptions(string) Constructor

Initializes options for the specified eve host or route prefix.

public EveClientOptions(string host);

Parameters

host System.String

An absolute host such as https://agent.example.com, or a relative prefix such as /api when the supplied HTTP transport has a base address.

Properties

EveClientOptions.AllowedProtectedHeaderOverrides Property

Gets protected header names that may be replaced through a dedicated per-call override. A name must be listed here and supplied through ProtectedHeaderOverrides or ProtectedHeaderOverrides.

public System.Collections.Generic.IReadOnlyCollection<string>? AllowedProtectedHeaderOverrides { get; init; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.String>

EveClientOptions.Authentication Property

Gets the authentication provider invoked before every request and stream reconnect. Its owned headers are protected from generic per-request values.

public NexusLabs.Eve.IEveAuthentication? Authentication { get; init; }

Property Value

IEveAuthentication

EveClientOptions.DeliveryRetryAttempts Property

Gets the maximum number of POST attempts used when delivering human-input responses.

public int DeliveryRetryAttempts { get; init; }

Property Value

System.Int32

EveClientOptions.DeliveryRetryDelay Property

Gets the delay between delivery retries for a session that has not propagated yet.

public System.TimeSpan DeliveryRetryDelay { get; init; }

Property Value

System.TimeSpan

EveClientOptions.Headers Property

Gets static headers included on every request. Content-specific headers are omitted when a request has no content.

public System.Collections.Generic.IReadOnlyDictionary<string,string>? Headers { get; init; }

Property Value

System.Collections.Generic.IReadOnlyDictionary<System.String,System.String>

EveClientOptions.HeadersProvider Property

Gets an optional dynamic header provider invoked before every request. Dynamic values override entries in Headers.

public System.Func<System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyDictionary<string,string>>>? HeadersProvider { get; init; }

Property Value

System.Func<System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyDictionary<System.String,System.String>>>

EveClientOptions.Host Property

Gets the host or route prefix on which eve routes are mounted.

public string Host { get; }

Property Value

System.String

EveClientOptions.MaxStreamEventBytes Property

Gets the optional maximum UTF-8 byte count for one NDJSON stream event, excluding its line ending. A null value preserves the upstream unbounded behavior.

public System.Nullable<int> MaxStreamEventBytes { get; init; }

Property Value

System.Nullable<System.Int32>

EveClientOptions.PreserveCompletedSessions Property

Gets whether a normally completed session retains its continuation state for another turn. Failed sessions still reset.

public bool PreserveCompletedSessions { get; init; }

Property Value

System.Boolean

EveClientOptions.ProtectedHeaderNames Property

Gets additional header names that generic per-request values cannot replace. Use this for credentials supplied through Headers, HeadersProvider, or RequestHeadersProvider.

public System.Collections.Generic.IReadOnlyCollection<string>? ProtectedHeaderNames { get; init; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.String>

EveClientOptions.RequestHeadersProvider Property

Gets an optional dynamic header provider that receives the request operation before every request. This provider stays client-level: values override HeadersProvider but not protected headers.

public System.Func<NexusLabs.Eve.EveHttpRequestContext,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyDictionary<string,string>>>? RequestHeadersProvider { get; init; }

Property Value

System.Func<EveHttpRequestContext,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyDictionary<System.String,System.String>>>

EveClientOptions.TimeProvider Property

Gets the time provider used for retry delays.

public System.TimeProvider TimeProvider { get; init; }

Property Value

System.TimeProvider