Class PinpointClientOptions

Namespace

Acuit.Pinpoint.Services.Client

Assembly

Acuit.Pinpoint.Services.Client.dll

The base class for options that specify how to connect to an Acuit Pinpoint TCP SOAP service.

public abstract class PinpointClientOptions

Inheritance

object

PinpointClientOptions

Derived

PinpointFileServiceClientOptions

PinpointServiceClientOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PinpointClientOptions()

Initializes a new instance of the PinpointClientOptions class.

protected PinpointClientOptions()

Properties

Domain

Gets or sets the domain name to use when connecting using explicit credentials. This is ignored if UseTransportSecurity is false or if UserName is an empty string.

public string Domain { get; set; }

Property Value

string

Password

Gets or sets the password to use when connecting using explicit credentials. This is ignored if UseTransportSecurity is false or if UserName is an empty string.

public string Password { get; set; }

Property Value

string

PinpointHostName

Gets or sets the Acuit Pinpoint host name. Either PinpointHostName or ServiceUri is required.

public string PinpointHostName { get; set; }

Property Value

string

SendTimeout

Gets or sets the interval of time provided for a send operation to complete before the transport raises an exception. The default is 10 minutes.

public TimeSpan SendTimeout { get; set; }

Property Value

TimeSpan

ServiceUri

Gets or sets the service URI string. Either PinpointHostName or ServiceUri is required.

public string ServiceUri { get; set; }

Property Value

string

UseTransportSecurity

Gets or sets whether to use Transport Layer Security (TLS) over TCP. If this is false, no transport security is used. If this is true (the default), transport security is used, and if UserName is not an empty string, UserName, Password, and Domain are used for authentication; otherwise, the current Windows user's credentials are used.

public bool UseTransportSecurity { get; set; }

Property Value

bool

Remarks

UseTransportSecurity set to true with no user credentials specified can be used when a user on the same domain as the Acuit Pinpoint server is logged into Windows on the client computer.

UserName

Gets or sets the user name to use when connecting using explicit credentials. This is ignored if UseTransportSecurity is false.

public string UserName { get; set; }

Property Value

string

Methods

GetEffectiveServiceUri()

Gets the Acuit Pinpoint service URI string to use based on the options.

public abstract string GetEffectiveServiceUri()

Returns

string

The service URI string.

Exceptions

InvalidOperationException

The options are invalid.

GetEffectiveServiceUri(string)

Gets the Acuit Pinpoint service URI string to use based on the options and the specified default service name.

protected string GetEffectiveServiceUri(string defaultServiceName)

Parameters

defaultServiceName string

The default service name to use if building the URI from PinpointHostName.

Returns

string

The service URI string.

Remarks

If ServiceUri is set, it will be returned as-is, and PinpointHostName will be ignored. Otherwise, if PinpointHostName is set, the returned URI will be constructed from PinpointHostName as net.tcp://{PinpointHostName}/{defaultServiceName}. Otherwise, an InvalidOperationException will be thrown.

Exceptions

ArgumentNullException

defaultServiceName is null.

InvalidOperationException

The options are invalid.