Search Results for

    Show / Hide Table of Contents

    Class PhobosSettings

    Settings for the entire Phobos runtime for this ActorSystem.

    Inheritance
    System.Object
    PhobosSettings
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Phobos.Actor.Configuration
    Assembly: Phobos.Actor.dll
    Syntax
    public sealed class PhobosSettings

    Constructors

    PhobosSettings(ActorSystem)

    Creates a new PhobosSettings instance.

    Declaration
    public PhobosSettings(ActorSystem system)
    Parameters
    Type Name Description
    ActorSystem system

    The current ActorSystem

    PhobosSettings(Settings)

    Creates a new PhobosSettings instance.

    Declaration
    public PhobosSettings(Settings settings)
    Parameters
    Type Name Description
    Settings settings

    The current Settings for the ActorSystem

    PhobosSettings(Config)

    Creates a new PhobosSettings instance.

    Declaration
    public PhobosSettings(Config phobosConfig)
    Parameters
    Type Name Description
    Config phobosConfig

    The phobos configuration section in HOCON.

    PhobosSettings(TracingSettings, MonitoringSettings)

    Declaration
    public PhobosSettings(TracingSettings tracingSettings, MonitoringSettings monitoringSettings)
    Parameters
    Type Name Description
    TracingSettings tracingSettings
    MonitoringSettings monitoringSettings

    Properties

    ActorSettings

    The default settings used by all /user actors in this ActorSystem.

    Declaration
    public PhobosActorSettings ActorSettings { get; }
    Property Value
    Type Description
    PhobosActorSettings

    Monitoring

    The monitoring settings.

    Declaration
    public MonitoringSettings Monitoring { get; }
    Property Value
    Type Description
    MonitoringSettings

    Tracing

    The tracing settings.

    Declaration
    public TracingSettings Tracing { get; }
    Property Value
    Type Description
    TracingSettings

    Methods

    DefaultConfig()

    The default HOCON configuration for Phobos.

    Declaration
    public static Config DefaultConfig()
    Returns
    Type Description
    Config

    A Config object containing the Phobos and Phobos.Tracing default configurations.

    For(ActorSystem)

    Returns the currently configured PhobosSettings for this ActorSystem.

    Declaration
    public static PhobosSettings For(ActorSystem system)
    Parameters
    Type Name Description
    ActorSystem system

    The current ActorSystem

    Returns
    Type Description
    PhobosSettings

    The current Phobos settings.

    WithMonitoringSettings(MonitoringSettings)

    Declaration
    public PhobosSettings WithMonitoringSettings(MonitoringSettings monitoringSettings)
    Parameters
    Type Name Description
    MonitoringSettings monitoringSettings
    Returns
    Type Description
    PhobosSettings

    WithTracingSettings(TracingSettings)

    Declaration
    public PhobosSettings WithTracingSettings(TracingSettings traceSettings)
    Parameters
    Type Name Description
    TracingSettings traceSettings
    Returns
    Type Description
    PhobosSettings
    In This Article
    Back to top Generated by DocFX