Class SdkAppCommandLineArgs

Namespace

RDCore.SDK.Server.Configuration

Assembly

RDCore.SDK.dll

Configuration settings overridden from command-line arguments.

public record SdkAppCommandLineArgs : IEquatable<SdkAppCommandLineArgs>

Inheritance

object

SdkAppCommandLineArgs

Implements

IEquatable<SdkAppCommandLineArgs>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Regroups all command-line arguments in one place, sorted by alias / short name.

Properties

ClientProcessId

A command-line argument that provides the ClientProcessId owner process ID to a server app.

[Option('p', "client-id")]
public int? ClientProcessId { get; init; }

Property Value

int?

Remarks

👉 This argument is required for starting a server app.

ConnectTimeoutSeconds

A command-line argument that overrides the ConnectTimeoutSeconds setting.

[Option('c', "connect-timeout")]
public int? ConnectTimeoutSeconds { get; init; }

Property Value

int?

DefaultLocation

A command-line argument that overrides the DefaultLocation setting.

[Option('d', "default-location")]
public string? DefaultLocation { get; init; }

Property Value

string

HealthCheckIntervalSeconds

A command-line argument that overrides the HealthCheckIntervalSeconds setting.

[Option('k', "healthcheck-timeout")]
public int? HealthCheckIntervalSeconds { get; init; }

Property Value

int?

PipeName

A command-line argument that overrides the PipeName setting.

[Option('n', "name")]
public string? PipeName { get; init; }

Property Value

string

ShowHelp

A command-line argument that overrides the application startup sequence and outputs command-line arguments documentation instead.

[Option('h', "help")]
public bool? ShowHelp { get; init; }

Property Value

bool?

ShutdownTimeoutSeconds

A command-line argument that overrides the ShutdownTimeoutSeconds setting.

[Option('s', "shutdown-timeout")]
public int? ShutdownTimeoutSeconds { get; init; }

Property Value

int?

TraceLevel

A command-line argument that overrides the TraceLevel setting.

[Option('t', "trace")]
public LogLevel? TraceLevel { get; init; }

Property Value

LogLevel?

Type

A command-line argument that overrides the HealthCheckIntervalSeconds setting.

[Option('m', "mode")]
public ServerTransportLayerMode Type { get; init; }

Property Value

ServerTransportLayerMode

UnsafeDevMode

A command-line switch that overrides the TraceLevel setting.

[Option("unsafe-dev-mode", Hidden = true)]
public bool? UnsafeDevMode { get; init; }

Property Value

bool?

Remarks

👉 This switch has no alias and does not appear in help documentation.

Verbose

A command-line argument that overrides the Verbose setting.

[Option('v', "verbose")]
public bool? Verbose { get; init; }

Property Value

bool?

WorkspaceUri

A command-line argument that overrides the WorkspaceUri setting.

[Option('w', "workspace")]
public string? WorkspaceUri { get; init; }

Property Value

string

Remarks

👉 This argument is required for starting a server app.