Class ServerHostOptions

Process settings of the server application, configuration section Section.

Inheritance
object
ServerHostOptions
Implements
Inherited Members
Namespace: Uniform.Chat.Server
Assembly: uniform-chat-server.dll
Syntax
public sealed record ServerHostOptions : IEquatable<ServerHostOptions>

Fields

| Edit this page View Source

Section

Configuration section name.

Declaration
public const string Section = "Host"
Field Value
Type Description
string
| Edit this page View Source

ServiceAdminSocket

The admin socket of the system service, which its unit sets and uniform-chat-server manage opens by default.

Declaration
public const string ServiceAdminSocket = "/run/uniform-chat-server/admin.sock"
Field Value
Type Description
string

Properties

| Edit this page View Source

AdminSocket

A local Unix socket for managing the running server, e.g. /run/uniform-chat-server/admin.sock: whoever may open it, by its file permissions, manages the server with uniform-chat-server manage as an admin, without an account. The socket is made readable and writable by the server's user and group only. Empty for none.

Declaration
public string? AdminSocket { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Ui

Whether to run with the dashboard: Auto, Dashboard or None.

Declaration
public UiMode Ui { get; set; }
Property Value
Type Description
UiMode

Methods

| Edit this page View Source

UseDashboard(out string)

Return whether to show the dashboard: forced by Ui, or for Auto when input and output are a terminal; reason says why.

Declaration
public bool UseDashboard(out string reason)
Parameters
Type Name Description
string reason
Returns
Type Description
bool
Remarks

Service managers such as systemd connect input to /dev/null and output to a log, so they count as redirected. Environment variables such as INVOCATION_ID are not used, as terminals started by a systemd user session inherit them.

Implements