Search Results for

    Show / Hide Table of Contents

    Class WssClientOptions

    Holds behavioral settings for WssClient.

    Inheritance
    object
    WssClientOptions
    Namespace: Wss.CoreModule
    Assembly: WSS_Core_Interface.dll
    Syntax
    public sealed class WssClientOptions
    Remarks

    The constructor requires a non-null options instance and validates ResponseTimeout to ensure it is greater than zero. Address settings control how logical targets map to on-wire receiver addresses.

    Properties

    BroadcastTarget

    Gets or sets the on-wire broadcast receiver address used for logical Broadcast. The default is 0x8F.

    Declaration
    public byte BroadcastTarget { get; set; }
    Property Value
    Type Description
    byte

    OwnsTransport

    Gets or sets whether disposing the client also disposes the underlying transport. The default is true.

    Declaration
    public bool OwnsTransport { get; set; }
    Property Value
    Type Description
    bool

    ResponseTimeout

    Gets or sets the maximum time to wait for a correlated reply before canceling the request. This must be greater than zero. The default is 2 seconds.

    Declaration
    public TimeSpan ResponseTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan

    Sender

    Gets or sets the sender address byte placed in outbound frames. The default is 0x00.

    Declaration
    public byte Sender { get; set; }
    Property Value
    Type Description
    byte

    WssTargets

    Gets or sets the on-wire receiver addresses for logical Wss1, Wss2, and Wss3.

    Declaration
    public byte[] WssTargets { get; set; }
    Property Value
    Type Description
    byte[]
    Remarks

    Index 0 maps to Wss1, index 1 to Wss2, and index 2 to Wss3. When null or shorter than three entries, the client falls back to the historical defaults for missing values.

    In this article
    Back to top Generated by DocFX