Class ServerOptions

Namespace

IceRpc

Assembly

IceRpc.dll

Represents a property bag used to configure a Server.

public sealed record ServerOptions : IEquatable<ServerOptions>

Inheritance

object

ServerOptions

Implements

IEquatable<ServerOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConnectTimeout

Gets or sets the connection establishment timeout for connections accepted by the server.

public TimeSpan ConnectTimeout { get; set; }

Property Value

TimeSpan

Defaults to 10 seconds.

ConnectionOptions

Gets or sets the connection options for server connections.

public ConnectionOptions ConnectionOptions { get; set; }

Property Value

ConnectionOptions

The connection options. Defaults to a default constructed ConnectionOptions.

MaxConnections

Gets or sets the maximum number of accepted server connections. Once the maximum number of connections has been reached, the server will refuse any new connections.

public int MaxConnections { get; set; }

Property Value

int

The maximum number of connections. Defaults to 0, meaning unlimited.

MaxPendingConnections

Gets or sets the maximum number of server connections waiting for connection establishment to complete. Once the maximum number of pending connections has been reached, the server will stop accepting new connections to ensure that the transport rejects new connections once its connection backlog is full.

public int MaxPendingConnections { get; set; }

Property Value

int

The maximum number of connection waiting for connection establishment to complete. Defaults to 100.

ServerAddress

Gets or sets the server's address. The server address host is usually an IP address, and it cannot be a DNS name.

public ServerAddress ServerAddress { get; set; }

Property Value

ServerAddress

The ServerAddress of this Server. Defaults to a ServerAddress constructed with IceRpc.

ServerAuthenticationOptions

Gets or sets the SSL server authentication options.

public SslServerAuthenticationOptions? ServerAuthenticationOptions { get; set; }

Property Value

SslServerAuthenticationOptions

The SSL server authentication options. When not null, the server will accept only secure connections.

ShutdownTimeout

Gets or sets the shutdown timeout. This timeout is used when gracefully shutting down a connection managed by the server.

public TimeSpan ShutdownTimeout { get; set; }

Property Value

TimeSpan

Defaults to 10 seconds.