TROServerLocator

Overview

This class contains configuration data for an individual server that will be included in fail-over and load balancing support of a TROTransportChannel component.

You will not instantiate instances of this class yourself, but rather use the TROTransportChannel collection property to define server locator's for your channel.

Location

 

constructor Create  override

Creates a new instance.

constructor Create(Collection: TCollection)

Parameters:

  • Collection: collection

Assign  override

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

DisableOnFailure

Toggles whether the server will automatically disabled if a call fails. How and if a once-disabled server will get re-enabled depends on the ProbingOptions property.

property DisableOnFailure: boolean read write

DoEnabledChangedEvent  protected virtual

procedure DoEnabledChangedEvent

Enabled

Determines whether the server is to be included in load balancing or fail-over support.

property Enabled: boolean read write

GetDisplayName  protected override

Returns the name of the server locator as it appears in the collection editor.

function GetDisplayName: string

GetNamePath  override

function GetNamePath: string

Host

Defines the TCP host address of the server.

property Host: string read write

HTTPDispatcher

property HTTPDispatcher: string read write

LoadBalancingServer

Specifies if this server is to be included in load balancing. If set to false, the server will only be considered for fail-over support if another server failed; it will not be included in normal load balancing scheduling.

property LoadBalancingServer: boolean read write

Name

Sets a readable name for the server.

property Name: string read write

OnEnabledChanged

Fires if the Enabled status of the server locator changes, due to probing, a failed request or manual change from code. You can use this event to check the status of the server locator, possibly to update internal data structures to or to display server status in the user interface.

property OnEnabledChanged: TROServerLocatorNotifyEvent read write
delegate: procedure OnEnabledChanged(Sender: TROServerLocator)

Port

The server's TCP port.

property Port: integer read write

ProbingOptions

Specifies how this server will be handled during probing. The four available options include:

  • Include this server in probing, if it's already enabled.
  • Include this server in probing, if it's currently disabled. Activating this option is the only way a once-disabled server will ever be automatically re-enabled.
  • (Re-)enable the server if it was successfully probed. Activating this option is the only way a once-disabled server will ever be automatically re-enabled.
  • Disable this server if probing failed. (see also DisableOnFailure).
property ProbingOptions: TROProbingOptions read write

TargetUri

Target URI

property TargetUri: TROUri read write

TargetUrl

The address of the server.

property TargetUrl: string read write

 

DisableOnFailure

Toggles whether the server will automatically disabled if a call fails. How and if a once-disabled server will get re-enabled depends on the ProbingOptions property.

property DisableOnFailure: boolean read write

Enabled

Determines whether the server is to be included in load balancing or fail-over support.

property Enabled: boolean read write

Host

Defines the TCP host address of the server.

property Host: string read write

HTTPDispatcher

property HTTPDispatcher: string read write

LoadBalancingServer

Specifies if this server is to be included in load balancing. If set to false, the server will only be considered for fail-over support if another server failed; it will not be included in normal load balancing scheduling.

property LoadBalancingServer: boolean read write

Name

Sets a readable name for the server.

property Name: string read write

Port

The server's TCP port.

property Port: integer read write

ProbingOptions

Specifies how this server will be handled during probing. The four available options include:

  • Include this server in probing, if it's already enabled.
  • Include this server in probing, if it's currently disabled. Activating this option is the only way a once-disabled server will ever be automatically re-enabled.
  • (Re-)enable the server if it was successfully probed. Activating this option is the only way a once-disabled server will ever be automatically re-enabled.
  • Disable this server if probing failed. (see also DisableOnFailure).
property ProbingOptions: TROProbingOptions read write

TargetUri

Target URI

property TargetUri: TROUri read write

TargetUrl

The address of the server.

property TargetUrl: string read write

 

constructor Create  override

Creates a new instance.

constructor Create(Collection: TCollection)

Parameters:

  • Collection: collection

Assign  override

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

DoEnabledChangedEvent  protected virtual

procedure DoEnabledChangedEvent

GetDisplayName  protected override

Returns the name of the server locator as it appears in the collection editor.

function GetDisplayName: string

GetNamePath  override

function GetNamePath: string

 

OnEnabledChanged

Fires if the Enabled status of the server locator changes, due to probing, a failed request or manual change from code. You can use this event to check the status of the server locator, possibly to update internal data structures to or to display server status in the user interface.

property OnEnabledChanged: TROServerLocatorNotifyEvent read write
delegate: procedure OnEnabledChanged(Sender: TROServerLocator)

See Also